《ios软件代码规范》由会员分享，可在线阅读，更多相关《ios软件代码规范（34页珍藏版）》请在金锄头文库上搜索。
1、iOS软件代码规范目 录修订记录3前 言41.指导原则52.布局52.1.文件布局62.2.基本格式82.3.对齐92.4.空行空格112.5.断行133.注释144.命名规则174.1.基本规则174.2.资源命名195.变量，常量，宏与类型195.1.变量、常量以及宏195.2.类型216.表达式与语句227.函数、方法、接口278.头文件289.可靠性299.1.内存使用299.2.指针使用319.3.类3210.断言与错误处理3211.其它补充3312.参考文档34修订记录日期修订版本描述修改人2011-11-30V1.0.1参考BREW编程规范拟制iOS代码规范陈达剑2011-12-
2、12V1.0.2增加指针规则以及其它补充陈达剑前 言本规范针对于iOS的object-c开发语言。 1. 指导原则【原则1-1】首先是为人编写程序，其次才是计算机。说明：这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。【原则1-2】保持代码的简明清晰，避免过分的编程技巧。说明：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。【原则1-3】编程时首先达到正确性，其次考虑效率。说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考
3、虑程序的效率和资源占用。【原则1-4】编写代码时要考虑到代码的可测试性。说明：不可以测试的代码是无法保障质量的，开发人员要牢记这一点来设计、编码。实现设计功能的同时，要提供可以测试、验证的方法。【原则1-5】函数（方法）是为一特定功能而编写，不是万能工具箱。说明：方法是一个处理单元，是有特定功能的，所以应该很好地规划方法，不能是所有东西都放在一个方法里实现【原则1-6】鼓励多加注释。【原则1-7】内存空间在哪分配在哪释放。2. 布局程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效
4、率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且会涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。2.1. 文件布局【规则2-1-1】遵循统一的布局顺序来书写头文件。说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。头文件布局: 文件头（参见“注释”一节） #import （依次为标准库头文件、非标准库头文件） 全局宏常量定义 全局数据类型 类定义正例：/* * 文件引用 */ /* * 类引用 */ /* * 宏定义 */ /*
5、 * 常量 */ /* * 类型定义 */ / * * 类定义 */【规则2-1-2】遵循统一的布局顺序来书写实现文件。说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。实现文件布局： 文件头（参见“注释”一节） #import （依次为标准库头文件、非标准库头文件） 文件内部使用的宏常量定义 文件内部使用的数据类型全局变量本地变量（即静态全局变量） 类的实现正例：/* * 文件引用 */ /* * 宏定义 */ /* * 常量 */ /* * 类型定义 */ /* * 全局变量 */ /* * 原型 */ / * * 类特性 */ implementation ClassNa
6、mesynthesize variableName;/ * * 类的实现 */ 【规则2-1-4】包含标准库头文件用尖括号 ，包含非标准库头文件用双引号 “ ”。正例：#import #import “heads.h”2.2. 基本格式【规则2-2-1】if、else、else if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 。说明：这样可以防止书写失误，也易于阅读。正例：if (varible1 varible2) varible1 = varible2;反例：下面的代码执行语句紧跟if的条件之后，而且没有加，违反规则。if (varible1 varible2) varible1 = varible2; 【规则2-2-2】定义指针类型的变量，*应放在变量前。正例：float *pfBuffer
