20170620基础知识-编码规范

1、命名规范

大驼峰法：常量、枚举成员、类、结构体、枚举、协议、文件名、扩展文件（原始类型名+扩展名）

小驼峰法：变量、属性、函数、方法

2、注释

文件注释：开头，包括：版权信息、文件名、所在模块、作者信息、历史版本信息、文件内容、作用

文档注释：生成API帮助文档，类型、属性、方法、函数，应该是非私有  单行：///  多行：/**。。。*/

代码注释：给看源码的人参考；文档注释给看不到源码的人参考

地标注释：MARK（用于方法、函数的注释） TODO（表示这里的代码有没有完成或者还要处理）  FIXME（表示修改了代码）

3、声明

①每行声明变量或者常量的数量为1个

②尽量采用类型判断

③如果不是默认数据类型，需要明确声明变量或常量的数据类型

④变量或常量与冒号之间没有空格，冒号和数据类型直接有一个空格

⑤尽可能使用Swift原生的数据类型

⑥只读的计算属性，尽量省略get语句， var fullName: String { return firstName + “.” + lastName }

4、代码排版

空行：类型声明之前、import语句前后、两个方法函数之间、注释之前、一个源文件的两个片段之间

空格：赋值符号“=”前后各有一个空格、var let与标识符之间有空格、二元运算符用空格与操作数分开、“(”的右边“)”的左边不应该有空格、大括号前有一个空格、方法与第一个参数之间没有空格，后面的参数前要有一个空格，参数与冒号之间有空格

断行：一行代码的长度应尽量不超过80个字符

对于较长的代码的断行：在一个逗号后面断开、在一个操作符前面断开，选择较高级别的运算符、新的一行相对于上一行缩进8个空格（2个级别）

缩进：包含{}的代码块中，代码块的内容相对于首行缩进4个空格（1个级别）、if条件的断行，要缩进8个空格（2个级别）