iOS翻译 Cocoa编码规范
Posted IOS培训
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了iOS翻译 Cocoa编码规范相关的知识，希望对你有一定的参考价值。
来源：葛布林大帝的博客
简介：
本文整理自Apple文档《Coding Guidelines for Cocoa》。这份文档原意是给Cocoa框架、插件及公共API开发者提供一些编码指导，实质上相当于Apple内部的编码规范。在多人协作时，一份统一的代码规范大大减少开发者之间的沟通成本，极力推荐。
目录：
一、代码命名基础
二、方法
三、函数
四、Property及其他
五、缩写
一、代码命名基础
1.通用原则
1.1 清晰
尽量清晰又简洁，无法两全时清晰更重要
通常不应缩写名称，即使方法名很长也应完整拼写
你可能认为某个缩写众所周知，但其实未必，特别是你周围的开发者语言文化背景不同时
有一些历史悠久的缩写还是可以使用的，详见第五章
API命名避免歧义，例如一个方法名有多种理解
1.2 一致
尽力保持Cocoa编程接口命名一致
如果有疑惑，请浏览当前头文件或者参考文档
当某个类的方法使用了多态时，一致性尤其重要
不同类里，功能相同的方法命名也应相同
1.3 避免自引用（self Reference）
命名不应自引用
这里的自引用指的是在词尾引用自身
Mask与Notification忽略此规则
2.前缀
前缀是编程接口命名的重要部分，它们区分了软件的不同功能区域：
前缀可以防止第三方开发者与Apple的命名冲突
同样可以防止Apple内部的命名冲突
前缀有指定格式
它由二到三个大写字母组成，不使用下划线和子前缀
命名类、协议、函数、常量和typedef结构体时使用前缀
方法名不使用前缀（因为它存在于特定类的命名空间中）
结构体字段不使用前缀
3.书写约定
在命名API元素时， 使用驼峰命名法（如runTheWordsTogether），并注意以下书写约定：
方法名
小写第一个字母，大写之后所有单词的首字母，不使用前缀
如果方法名以一个众所周知的大写缩略词开始，该规则不适用
如TIFFRepresentation (NSImage)
fileExistsAtPath:isDirectory:
函数及常量名
使用与其关联类相同的前缀，并大写首字母
NSRunAlertPanel以上是关于iOS翻译 Cocoa编码规范的主要内容，如果未能解决你的问题，请参考以下文章