对于可维护的代码,命名规则非常重要。 在iOS开发中Objective-C的方法名往往十分长,但代码块读起来就像散文一样,不需要太多的注释修饰。
1. 文件名
文件的扩展名应该如下:
● .h, C/C++/Objective-C的头文件
● .m, Ojbective-C实现文件
● .mm, Ojbective-C++的实现文件
● .cc, 纯C++的实现文件
● .c, 纯C的实现文件
分类的文件名应该包含被扩展的类的名字,如:GTMNSString+Utils.h或GTMNSTextView+Autocomplete.h。
2. 类名
· 类名(及其category name和protocol name)的首字母大写,使用首字母大写的形式分割单词。
· 在面向特定应用的代码中,类名应尽量避免使用前缀,每个类都使用相同的前缀影响可读性。
· 在面向多应用的代码中,推荐使用前缀。如:GTMSendMessage。
3. 方法名
· 方法名的首字母小写,且使用首字母大写的形式分割单词。方法的参数使用相同的规则。
· 方法名+参数应尽量读起来像一句话(如:)。在这里查看苹果对方法命名的规范。
· getter的方法名和变量名应相同。不允许使用“get”前缀。如:
(id)getDelegate; // 禁止
(id)delegate; // 正确
· 本规则仅针对Objective-C代码,C++代码使用C++的习惯。
4.变量名
Objective-C 是区分大小写的, 比如声明一个描述图片宽度的变量, pictureWidth 与 pictureWIDTH 或 PictureWidth 是不一样的。 为了与大多数人的编程习惯一致,在变量名命名时,通常是把若干个词组在一起,第一个词的首字母小写,其他所有词的首字母大写。 严格遵守这个约定,可以减少很多因区分大小写带来的错误。
在使用变量名时,要遵循一定的规则:
· 不能使用Objective-C 的保留字。所谓保留字,也就是在Objective-C 语言中已经有了特殊含义的单词。 使用简明的单词组成变量名,比如picuteWidht 通常是安全的。为了确保变量名的可读性,推荐在变量名中间使用大写字母。
· 一个变量名不能以数字开头,但数字可以出现在变量名中间。
· 可以使用下划线 “_” , 下划线可以用在变量的开头,也可以用在变量的中间。
通过举例说明以上规则。
合法的变量名写法: picuture6s, picture_6s
不合法的变量名写法: picuture 6 (中间有空格), 6Picuture (以数字开头)
不推荐的变量名写法: Picuture6s (开头使用大写字母)
|