美文网首页
Objective-C代码规范

Objective-C代码规范

作者: 敲代码的树懒 | 来源:发表于2016-06-12 15:28 被阅读139次

原文地址
http://www.cnblogs.com/colinhou/p/3736034.html
我们写出来的代码会给很多人看,为了使代码清晰简洁,方便阅读理解,都会统一遵从一定的代码规范,Objective-C同样如此。

主要参考规范:

  1. Google Objective-C Style Guide

  2. Coding Guidelines for Cocoa

简单总结一下目前接触到的:

1.代码行度最大为100列(C++的是80)



2.声明类或方法时,注意空格的使用,参数过多时可换行保持对齐,



调用方法时也是如此,参数都写在一行或换行冒号对齐,

3.命名规则

类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像一句话,能够传达出方法的意思,同时取值方法前不要加前缀“get”



变量名小写字母开头



常量以小写字母k开头,后续首字母大写

4.关于注释

注释很重要,但除了开头的版权声明,尽可能把代码写的如同文档一样,让别人直接看代码就知道意思,写代码时别担心名字太长,相信Xcode的提示功能。

5.实例变量应该在实现文件.m中声明或以@property形式在.h文件中声明,一定要直接在.h文件声明,加上@priavte,另外,使用@private、@public,前面需要一个缩进空格。

6.尽可能保证 .h文件的简洁性,可以不公开的API就不要公开了,写在实现文件中即可。

7.Xcode支持Objective-C/C/C++混编,所以引用头文件时:#import Ojbective-C/Objective-C++头文件(Objective-C++是Objective-C与C++混编的文件),#include C/C++头文件。

8.写delegate的时候类型应该为weak弱引用,以避免循环引用,当delegate对象不存在后,我们写的delegate也就没有存在意义了自然是需要销毁的,weak与strong可以参考上一篇文章介绍。


9.实例变量声明时变量名前面加下划线“_”,局部变量不用加。


10.使用Block时,内容四个空格缩进,“^”后带有参数时,参数与“{”之间有一个空格缩进


11.建议使用“#pragma mark”,方便阅读代码


其他详细参考两个规范说明,Coding Guidelines for Cocoa 还列举了详细的命名要求。

相关文章

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

  • Objective-C代码规范

    团队的Objective-C代码规范。本文主要内容来自raywenderlich.com Objective-C编...

  • Objective-C我的代码规范

    Objective-C代码规范 前言 代码规范,统一才是最好的,团队开发中切记不要自己搞一套,跟着团队规范走 目录...

  • iOS 代码规范

    iOS规范:仅适用于iOS的代码规范(使用Objective-C语言)。 一.代码应该简洁易懂,逻辑清晰 不要过分...

  • iOS代码规范

    iOS代码规范 一、前言 本规范基于Google Objective-C Style Guide和百度Object...

  • 代码规范

    苹果代码规范 禅与 Objective-C 编程艺术 (Zen and the Art of the Object...

  • Objective-C编程规范

    引言 背景 Apple官方的代码规范, 供补充参考: The Objective-C Programming La...

  • iOS(Objective-C)编码规范

    iOS(Objective-C)编码规范 本文件旨在统一****iOS方向编码规范。增强代码可读性,便于后期维护。...

  • 2020-07-24

    # 纽约时报 移动团队 Objective-C 规范指南 这份规范指南概括了纽约时报 iOS 团队的代码约定。 #...

  • Objective-C 代码规范

    0. 前言 "代码是写给人看的" 例子? 1. 布局与风格 良好布局的目的 准确表现代码的逻辑结构 始终如一地表现...

网友评论

      本文标题:Objective-C代码规范

      本文链接:https://www.haomeiwen.com/subject/kviedttx.html