iOS代码编写规范

最基本的命名规范，一定要遵守（与苹果命名规范一致，多看看苹果各个API中的.h文件和一些Sample Code）

 

- 看这个官方文档：http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html

- 所有命名要有意义，不要用自认为好理解的缩写，宁可名称长一些也没关系，易读性是首位

- 命名时要带上类型，比如：xxxArray，xxxDictionary，xxxSize，等等，这样可以从名称上知晓是什么类型变量，而不用总去查声明。当然，千万不要一个NSArray的变量命名为xxxDictionary，那样是非常招骂的

- 类名首字母大写，如：@interface MyClass: NSObject

- 函数名第一个字母小写，后面单词首字母大写；如果有参数，第一个参数要从函数名称上携带出来，myFunctionWithXxx；第二个参数的首字母小写；完整示例如：- (void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)sizeB{}

- 变量名第一个字母小写，后面单词首字母大写，如：myVariable

- 常量名全大写，如：MYCONSTANT

 

这些是最基本命名规范，一定要遵守，其他的先不做强制性要求，但还希望大家多参考苹果的规范性做法，为了自己方便，更为了别人维护方便，下面是几个其他的命名规范方面的建议。

 

- 私有实例变量前加一个下划线，如_myPrivateVariable，可能有的C++程序员喜欢加2个下划线表示完全私有，但OC中没有这个必要。

- 一些常量加一些前缀，可以做为不同常量的区分，同时也方便写代码时利用xcode提示快速找到所需要的变量，比如：User Defaults key的变量前加UDKEY_，UDKEY_XXXX，Notification Name key前面加NNKey_，NNKEY_XXXX，Dictionary key前面加DICTKEY_，DICTKEY_XXXX

- enum变量也要有相应前缀来区分不同的enum常量，比如用苹果的一个enum举例：

UIViewAnimationTransitionNone,

UIViewAnimationTransitionFlipFromLeft,

UIViewAnimationTransitionFlipFromRight,

UIViewAnimationTransitionCurlUp,

UIViewAnimationTransitionCurlDown,

} UIViewAnimationTransition;

另外：私有函数也最好在前面加上_ 类似于我看得Sample Code中，只在本类中得函数皆在前面打上_符号