iOS开发代码规范

一、代码规范

1. 命名规则

    1)类名首字母大写,方法首字母小写,方法中的参数首字母小写,同时尽量让方法的命名读起来像一句话,能够传达出方法的意思。 

    2)常量和变量命名小写字母开头,采用“驼峰命名法”,并且要做到见名知其意。

    3)宏命名大写。

    4)代理名称:类名+Delegate                    代理方发名称:  类名+方法实际意义

代理命名规范

2. 注释

      注释很重要,但除了开头的版权声明,尽可能把代码写的如同文档一样,让别人直接看代码就知道意思。(iOS端项目注释规范附统一代码块)

注释分几类:

1)属性注释

属性注释 使用 /** 注释*/ 的文档注释格式。 这种注释相较于// 注释的优点是此属性可以在后面的引用时,在智能提示的下方显示中文注释。

属性名、方法名注释

2)方法集注释

每个代理的方法可以归结为一个整体的方法集,在方法集中实现协议的所有代理方法。命名规范:#pragma mark - 方法集名称,上空两行,下空一行。

方法集注释

补充说明:系统自带方法集注释为#pragma mark ,平时自己使用时尽量在后面加上-,即#pragma  mark -,这样注释的方法集会有一条分割线,方便查找代码时分隔开不同的方法集。使用方式见下图

方法集注释补充说明

3)普通注释

在项目中的某个地方的逻辑可能比较复杂或者是核心思想的代码,这种地方应加上一些注释作为标注,也利于自己维护代码,利于之后别人接手代码。

普通注释

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

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

实例变量声明
局部变量声明

5. 写delegate的时候类型应该为weak弱引用,以避免循环引用,当delegate对象不存在后,我们写的delegate也就没有存在意义了自然是需要销毁的。

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

block代码规范

补充说明:若要调整整个.m的代码规范,也可以全选,然后  “control+i”  快捷键缩进空格。

7.编码排版格式

编码排版  图1
编码排版  图2
编码排版  图3
编码排版  图4

8. 对于系统的常用类作实例变量声明时加入后缀:

系统的常用类作实例变量声明加后缀

二、类代码组织原则

一个原则:析构函数- (void)dealloc最好放到类最上面,第一眼就可以看到这个方法,可以方便看到是否remove了一些操作,对内存的合理释放等,controller,view的生命周期函数放到最上面,自己实现的方法在下面,相同/相近功能的方法采用#pragma mark -来标记,以便查看。

示例:

1.系统生命周期函数方法


2.遵循协议方法
3.自定义方法声明
4.网络数据加载
5.视图构建方法

三、补充说明

1. 删除多余的空行

* 所有方法与方法之间空1行

* 所有代码块之间空1行

2. 删除多余的注释

* 删除注释掉的代码

* 删除没有意义的注释

3. 删除多余的方法

* 如果方法没有使用到,请删除它

* 如果方法没有执行任何业务逻辑,请删除它或者给出一定注释

4. 删除未被使用的资源文件

5. 添加必要的注释

* 所有 .h 文件中的property 需要给出注释

* 所有自定义的方法需要给出注释

* 比较大的代码块需要给出注释

* 所有代码中出现的阿拉伯数字需要给出注释

* 程序中出现加密/解密 逻辑的操作地方,需要给出注释说明过程(无论是系统还是自定义)

6. 整体代码风格需要统一

* 代码后面的”{“ 不需要单独占用一行

* 逻辑运算符 与 代码之前空一格

* “#pragma mark -” 与下面的代码之前不要空行

* 遵循一般性的代码规范

参考链接:iOS开发规范  iOS编程规范  IOS开发编码及命名规范

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 此文整理是为了方便一些朋友规范代码适用于新人(ps:如果你已经很规范的执行了那么可以跳过此内容)这样以来如果有...
    无沣阅读 385评论 0 1
  • 开发代码规范 风格推荐 仿照 Cocoa 风格来,使用长命名风格,无论是变量,常量,属性,方法,类名等都应该尽量取...
    CerasusLand阅读 515评论 0 2
  • 1. 关于命名 1.1 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用...
    wei_j阅读 421评论 0 2
  • 关于命名1> 统一要求含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释使用全称,不使用缩写 2> 类...
    the宇亮阅读 284评论 0 0
  • 文/袁克林 从南卢到茅山,走的是好久未曾体验过的水路。挂桨船载着一船的人,挨挨挤挤地向着目的地徐徐进发...
    老人与海or阅读 209评论 0 1