文档介绍：iOS软件代码规范
目录
修订记录 3
前言 4
1. 指导原则 5
2. 布局 5
. 文件布局 6
. 基本格式 8
. 对齐 9
. 空行空格 11
. 断行 13
3. 注释 14
4. 命名规则 17
. 基本规则 17
. 资源命名 19
5. 变量,常量,宏与类型 19
. 变量、常量以及宏 19
. 类型 21
6. 表达式与语句 22
7. 函数、方法、接口 27
8. 头文件 28
9. 可靠性 29
. 内存使用 29
. 指针使用 31
. 类 32
10. 断言与错误处理 32
11. 其它补充 33
12. 参考文档 34
修订记录
日期
修订版本
描述
修改人
2011-11-30
参考BREW编程规范拟制iOS代码规范
陈达剑
2011-12-12
增加指针规则以及其它补充
陈达剑
前言
本规范针对于iOS的object-c开发语言。
指导原则
【原则1-1】首先是为人编写程序,其次才是计算机。
说明:这是软件开发的基本要点,软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程,只有易读、易维护的软件代码才具有生命力。
【原则1-2】保持代码的简明清晰,避免过分的编程技巧。
说明:简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧,否则会降低程序的可读性。
【原则1-3】编程时首先达到正确性,其次考虑效率。
说明:编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素,最后才考虑程序的效率和资源占用。
【原则1-4】编写代码时要考虑到代码的可测试性。
说明:不可以测试的代码是无法保障质量的,开发人员要牢记这一点来设计、编码。实现设计功能的同时,要提供可以测试、验证的方法。
【原则1-5】函数(方法)是为一特定功能而编写,不是万能工具箱。
说明:方法是一个处理单元,是有特定功能的,所以应该很好地规划方法,不能是所有东西都放在一个方法里实现
【原则1-6】鼓励多加注释。
【原则1-7】内存空间在哪分配在哪释放。
布局
程序布局的目的是显示出程序良好的逻辑结构,提高程序的准确性、连续性、可读性、可维护性。更重要的是,统一的程序布局和编程风格,有助于提高整个项目的开发质量,提高开发效率,降低开发成本。同时,对于普通程序员来说,养成良好的编程****惯有助于提高自己的编程水平,提高编程效率。因此,统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题,而且会涉及到产品质量,涉及到个人编程能力的提高,必须引起大家重视。
文件布局
【规则2-1-1】遵循统一的布局顺序来书写头文件。
说明:以下内容如果某些节不需要,可以忽略。但是其它节要保持该次序。
头文件布局:
文件头(参见“注释”一节)
#import (依次为标准库头文件、非标准库头文件)
全局宏
常量定义
全局数据类型
类定义
正例:
/***************************************************************************
* 文件引用
***************************************************************************/
/***************************************************************************
* 类引用
***************************************************************************/
/***************************************************************************
* 宏定义
***************************************************************************/
/***************************************************************************
* 常量
**************************************************************************