iOS软件代码规范Word文档下载推荐.docx

1、表达式与语句.函数、方法、接口 .头文件.可靠性.内存使用.指针使用.断言与错误处理.其它补充.参考文档.1113141719212227282931323334日期修订版本描述修改人2011-11-30V1.0.1参考BREW编程规范拟制iOS代码规范陈达剑2011-12-12V1.0.2增加指针规则以及其它补充本规范针对于iOS的object-c 开发语言。【原则1-1】首先是为人编写程序，其次才是计算机。说明：这是软件开发的基本要点， 软件的生命周期贯穿产品的开发、 测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。【原则1-2】保持代码的简明清

2、晰，避免过分的编程技巧。不要过分追求技巧，否则简单是最美。保持代码的简单化是软件工程化的基本要求。 会降低程序的可读性。【原则1-3】编程时首先达到正确性，其次考虑效率。编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考 虑程序的效率和资源占用。【原则1-4】编写代码时要考虑到代码的可测试性。不可以测试的代码是无法保障质量的， 开发人员要牢记这一点来设计、编码。实现设计功能的同时，要提供可以测试、验证的方法。【原则1-5】函数（方法）是为一特定功能而编写，不是万能工具箱。不能是所有东西方法是一个处理单元，是有特定功能的，所以应该很好地规划方法, 都放在一个方法里实现【原

3、则1-6】鼓励多加注释。【原则1-7】内存空间在哪分配在哪释放。2.布局程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、 可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提 高开发效率，降低开发成本。同时， 对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此， 统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题， 而且会涉及到产品质量， 涉及到个人编程能力的提高,须引起大家重视。2.1.文件布局【规则2-1-1】遵循统一的布局顺序来书写头文件。说明:以下内容如果某些节不需要，可以忽略

4、。但是其它节要保持该次序。头文件布局文件头（参见“注释”一节）#im port （依次为标准库头文件、非标准库头文件） 全局宏常量定义全局数据类型类定义正例:/* 文件引用*/* 类引用宏定义* 常量类型定义*/ / * 类定义【规则2-1-2】遵循统一的布局顺序来书写实现文件。实现文件布局：#im port （依次为标准库头文件、非标准库头文件） 文件内部使用的宏文件内部使用的数据类型全局变量本地变量（即静态全局变量）类的实现* 宏定义* 类型定义* 全局变量* 原型/ * 类特性impl eme ntati on ClassNamesyn thesize variableName;* 类的

5、实现【规则2-1-4 包含标准库头文件用尖括号 ，包含非标准库头文件用双引号#import #i mport “ heads.h2.2.基本格式【规则2-2-1 if、else else if、for、while、do等语句自占一行，执行语句不得紧跟其后。 不论执行语句有多少都要加if （varible1 ”这类操作符前后不加空格。!bValue-iValue+iCo unt*strSource&fSumaiNumberi = 5; tBox.dWidth tBox-dWidth正例：fValue【规则2-4-3】多元运算符和它们的操作数之间至少需要一个空格。fOldValue; fTotal

6、 + fValue iNumber += 2;【规则2-4-4】关键字之后要留空格。if、for、while等关键字之后应留一个空格再跟左括号 （以突出关键字。【规则2-4-5】函数名之后不要留空格。函数名后紧跟左括号（以与关键字区别。【规则2-4-6】方法名与形参不能留空格，返回类型与方法标识符有一个空格。方法名后紧跟，然后紧跟形参， 返回类型（与之间有一个空格。-凵（BOOL）shouldAutorotateTo In terfaceOrie ntati on :（UII nterfaceOrie ntatio n）i nterfaceOrie ntati on / Retur n YES

7、 for supp orted orie ntati ons.return （in terfaceOrie ntatio n = Ull nterfaceOrie ntatio nP ortrait）;【规则2-4-7】（向后紧跟，），、；向前紧跟，紧跟处不留空格。 ，之后要留空格。；不是行结束符号时其后要留空格。例子中的凵代表空格。for 凵（i 凵=凵 0;凵 i 凵 凵 MAX_BSC_NUM;凵 i+） DoSomething（iWidth,凵 iHeight）;【规则2-4-8】注释符与注释内容之间要用一个空格进行分隔。/*注释内容*/注释内容【规则2-5-1】长表达式（超过80列）

8、要在低优先级操作符处拆分成新行，操作符放在新行 之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐。条件表达式的续行在第一个条件处对齐。for循环语句的续行在初始化条件语句处对齐。 函数调用和函数声明的续行在第一个参数处对齐。 赋值语句的续行应在赋值号处对齐。if （iFormat = CH_A_Format_M） （iOfficeTy pe = CH_BSC_M） / 条件表达式的续行在第一个条件处对齐doSometh in g（）;/ for循环语句续行在初始化条件语句处对齐for （longjn itializatio n_stateme nt; long_con dict

9、 ion _stateme nt; long_up date_stateme nt）函数声明的续行在第一个参数处对齐BYTE Re portStatusCheck Para（HWND hWnd,BYTE ucCallNo,BYTE ucStatusRe portNo）;/赋值语句的续行应在赋值号处对齐fTotalBill = fTotalBill + faCustomerPurchasesilD+ fSalesTax（faCustomerPurchasesilD）;【规则2-5-2】函数（方法）声明时，类型与名称不允许分行书写。extern double FAR CalcArea（double

10、 dWidth, double dHeight）; 反例：extern double FARCalcArea（double dWidth, double dHeight）;3.注释注释有助于理解代码， 有效的注释是指在代码的功能、 意图层次上进行注释， 提供有用、 额外的信息，而不是代码表面意义的简单重复。【规则3-1】C语言的注释符为“ /*/”。C+语言中，多行注释采用“ /*/”，单行注释采用“ ”。1建议3-1不管多行还是单行，采用注释符“ /*/”。【规则3-2】一般情况下，源程序有效注释量必须在 30%以上。注释的原则是有助于对程序的阅读理解， 注释不宜太多也不能太少， 注释语言必

11、须准确、易懂、简洁。有效的注释是指在代码的功能、意图层次上进行注释，提供有用、 额外的信息。【规则3-3】注释使用中文。对于特殊要求的可以使用英文注释，如工具不支持中文或国际化版本时。【规则3-4】文件头部必须进行注释，包括： .h文件、.c文件、.m文件、.inc文件、.def文件、编译说明文件.cfg等。注释必须列出：版权信息、文件标识、内容摘要、版本号、作者、完成日期、修改信 息等。修改记录部分建议在代码做了大修改之后添加修改记录。备注： 文件名称，内容摘要，作者等部分一定要写清楚。下面是文件头部的中文注释：/*版权所有（C）2011中兴软件技术（南昌）有限公司/修改历史记录，包括修改日

12、期、修改者及修改内容*修改记录1 :*修改日期：*版本号：或版本号*修改人：*修改内容：/修改原因以及修改内容说明*修改记录2:*/【规则3-5】方法头部应进行注释， 列出：函数的目的/功能、输入参数、输出参数、返回值、 访问和修改的表、修改信息等，除了函数 （方法）名称和功能描述必须描述外，其它部分建议写描述。函数名称、功能描述、输入参数、输出参数、返 回 值、修改信息等。 备注：方法名称、功能描述要正确描述。*【规则3-6】注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句 的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。在使用缩写时或之前，应对缩

13、写进行必要的说明。如下书写比较结构清晰/*获得子系统索引 */iSubSys In dex = aDatail ndex.iSys In dex;反例1:/*代码段1注释*/代码段1 /*代码段2注释*/代码段2 如下例子注释与描述的代码相隔太远。/*获得子系统索引*/2：如下例子注释不应放在所描述的代码下面。iSubSys In dex = aDataiI ndex.iSys In dex;3：如下例子，显得代码与注释过于紧凑。【规则3-7】全局变量要有详细的注释，包括对其功能、取值范围、访问信息及访问时注意 事项等的说明。/*变量作用说明*变量值说明*/BYTE g_ucTra nErro

14、rCode;【规则3-8】注释与所描述内容进行同样的缩排。可使程序排版整齐，并方便注释的阅读与理解。如下注释结构比较清晰-（int）doSomething/*代码段1注释/*代码段2注释阅读不方便;1注释*/反例：如下例子，排版不整齐, int DoSometh in g（void）/*代码段2注释*/1建议3-2尽量避免在注释中使用缩写，特别是不常用缩写。在使用缩写时，应对缩写进行必要的说明。4.命名规则4.1.基本规则好的命名规则能极大地增加可读性和可维护性。同时，对于一个有上百个人共同完成的大项目来说，统一命名约定也是一项必不可少的内容。 本章对程序中的所有标识符 （包括变量名、常量名、

15、函数名、类名、结构名、宏定义等）的命名做出约定。【规则4-1】标识符要采用英文单词或其组合， 便于记忆和阅读，切忌使用汉语拼音来命名。标识符应当直观且可以拼读，可望文知义，避免使人产生误解。程序中的英文单词一 般不要太复杂，用词应当准确。【规则4-2】严格禁止使用连续的下划线，下划线也不能出现在标识符头或结尾（预编译开 关除外）。这样做的目的是为了使程序易读。 因为variablename和variable_name很难区分,下划线符号 _若出现在标识符头或结尾，容易与不带下划线 _的标识符混淆。【规则4-3】程序中不要出现仅靠大小写区分的相似的标识符。分割单词。预编译开关的定义【规则4-4】

16、宏、常量名都要使用大写字母，用下划线 使用下划线开始。女0 DISP_BUF_SIZE、MIN_VALUE、MAX_V ALUE 等等。【规则4-5】程序中局部变量不要与全局变量重名。尽管局部变量和全局变量的作用域不同而不会发生语法错误，但容易使人误解。【规则4-6】使用一致的前缀来区分变量的作用域。变量活动范围前缀规范如下（少用全局变量）g_s_空模块内静态变量局部变量不加范围前缀【规则4-7】方法名用小写字母开头的单词组合而成。方法名力求清晰、明了，通过方法名就能够判断方法的主要功能。方法名中不同意义 字段之间不要用下划线连接， 而要把每个字段的首字母大写以示区分。 方法命名采用大小写字母结合的形式，但专有名词不受限制。strfn参考匈牙利命名规则，常见的简写如下: 整型 指针 字符串 布尔 字符 函数interface CMainMenuint m_n Width;NStri ng *m_strName;BOOL m_bCheck;建议4-1尽量避免名字中出现数字编号，如 Value1、Value2等，除非逻辑上的确需要编号。1建议4-2标识符前最好不加项目、产品、部门的标识。这样做的目的是为了代码的可重用性。4.2.资源命名字符串：以“ IDS_”开头，如：IDS_VIEW图