标签：
|
目 录
前 言 1. 指导原则 2. 布局 2.1. 文件布局 2.2. 基本格式 2.3. 对齐 2.4. 空行空格 2.5. 断行 3. 注释 4. 命名规则 4.1. 基本规则 4.2. 资源命名 5. 变量，常量，宏与类型 5.1. 变量、常量以及宏 5.2. 类型 6. 表达式与语句 7. 函数、方法、接口 8. 头文件 9. 可靠性 9.1. 内存使用 9.2. 指针使用 9.3. 类 10. 断言与错误处理 11. 其它补充 12. 参考文档 1 本规范针对于iOS的object-c开发语言。
1. 指导原则
说明：这是软件开发的基本要点，软件的生命周期贯穿产品的开发、测试、生产、用户使用、版本升级和后期维护等长期过程，只有易读、易维护的软件代码才具有生命力。
说明：简单是最美。保持代码的简单化是软件工程化的基本要求。不要过分追求技巧，否则会降低程序的可读性。
说明：编程首先考虑的是满足正确性、健壮性、可维护性、可移植性等质量因素，最后才考虑程序的效率和资源占用。
说明：不可以测试的代码是无法保障质量的，开发人员要牢记这一点来设计、编码。实现设计功能的同时，要提供可以测试、验证的方法。
说明：方法是一个处理单元，是有特定功能的，所以应该很好地规划方法，不能是所有东西都放在一个方法里实现
2. 布局程序布局的目的是显示出程序良好的逻辑结构，提高程序的准确性、连续性、可读性、可维护性。更重要的是，统一的程序布局和编程风格，有助于提高整个项目的开发质量，提高开发效率，降低开发成本。同时，对于普通程序员来说，养成良好的编程习惯有助于提高自己的编程水平，提高编程效率。因此，统一的、良好的程序布局和编程风格不仅仅是个人主观美学上的或是形式上的问题，而且会涉及到产品质量，涉及到个人编程能力的提高，必须引起大家重视。 2.1.文件布局
说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 头文件布局: 文件头（参见“注释”一节） #import （依次为标准库头文件、非标准库头文件） 全局宏 常量定义 全局数据类型 类定义
正例： /*************************************************************************** * 文件引用 ***************************************************************************/
/*************************************************************************** * 类引用 ***************************************************************************/
/*************************************************************************** * 宏定义 ***************************************************************************/
/*************************************************************************** * 常量 ***************************************************************************/
/*************************************************************************** * 类型定义 ***************************************************************************/
/ *************************************************************************** * 类定义 ***************************************************************************/
说明：以下内容如果某些节不需要，可以忽略。但是其它节要保持该次序。 实现文件布局： 文件头（参见“注释”一节） #import （依次为标准库头文件、非标准库头文件） 文件内部使用的宏 常量定义 文件内部使用的数据类型 全局变量 本地变量（即静态全局变量） 类的实现
正例： /*************************************************************************** * 文件引用 ***************************************************************************/
/*************************************************************************** * 宏定义 ***************************************************************************/
/*************************************************************************** * 常量 ***************************************************************************/
/*************************************************************************** * 类型定义 ***************************************************************************/
/*************************************************************************** * 全局变量 ***************************************************************************/
/*************************************************************************** * 原型 ***************************************************************************/
/ *************************************************************************** * 类特性 ***************************************************************************/ @implementation ClassName
@synthesize variableName;
/ *************************************************************************** * 类的实现 ***************************************************************************/
正例： #import <stdio.h> #import “heads.h”
2.2.基本格式
说明：这样可以防止书写失误，也易于阅读。 正例： if (varible1 < varible2) { varible1 = varible2; } 反例：下面的代码执行语句紧跟if的条件之后，而且没有加{}，违反规则。
if (varible1 < varible2) varible1 = varible2;
正例： float *pfBuffer; 反例： float* pfBuffer;
说明：这样便于程序阅读和查找。 正例： iLength = 10; iWidth = 5; // 矩形的长与宽关系较密切，放在一起。 StrCaption = “Test”; 反例： iLength = 10; strCaption = “Test”; iWidth = 5;
2.3.对齐
说明：消除不同编辑器对TAB处理的差异，有的代码编辑器可以设置用空格代替TAB键。
说明：这样使代码便于阅读，并且方便注释。 do while语句和结构的类型化时可以例外，while条件和结构名可与 } 在同一行。 正例： (void)Function:(int)iVar { // 独占一行并与引用语句左对齐。 while (condition) { doSomething(); // 与{ }缩进4格 } } 反例： void Function(int iVar){ while (condition){ DoSomething(); }}
正例： int aiNumbers[4][3] = { 1, 1, 1, 2, 4, 8, 3, 9, 27, 4, 16, 64 }
正例： tPDBRes.wHead = 0; tPDBRes.wTail = wMaxNumOfPDB - 1; tPDBRes.wFree = wMaxNumOfPDB; tPDBRes.wAddress = wPDBAddr; tPDBRes.wSize = wPDBSize;
说明：使程序可读性更好。 正例： switch (iCode) { case 1: { DoSomething(); // 缩进4格 break; } case 2: { // 每一个case分支和default要用{}括起来 DoOtherThing(); break; } … // 其它case分支 default: { DoNothing(); break; } }
2.4.空行空格
说明：空行起着分隔程序段落的作用。适当的空行可以使程序的布局更加清晰。 正例： (void)hey { [hey实现代码] } // 空一行 // 空一行 (void)ack { [ack实现代码] } 反例： void Foo::Hey(void) { [Hey实现代码] } void Foo::Ack(void) { [Ack实现代码] } // 两个函数的实现是两个逻辑程序块，应该用空行加以分隔。
正例： !bValue ~iValue ++iCount *strSource &fSum aiNumber[i] = 5; tBox.dWidth tBox->dWidth
正例： fValue = fOldValue; fTotal + fValue iNumber += 2;
说明：if、for、while等关键字之后应留一个空格再跟左括号‘(’，以突出关键字。
说明：函数名后紧跟左括号‘(’，以与关键字区别。
说明：方法名后紧跟’:’，然后紧跟形参， 返回类型’(‘与’-‘之间有一个空格。 正例： -凵(BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation
正例： 例子中的 凵 代表空格。 for凵(i凵=凵0;凵i凵<凵MAX_BSC_NUM;凵i++) { DoSomething(iWidth,凵iHeight); }
正例： /* 注释内容 */ // 注释内容 反例： /*注释内容*/ //注释内容
2.5.断行
说明：条件表达式的续行在第一个条件处对齐。 for循环语句的续行在初始化条件语句处对齐。 函数调用和函数声明的续行在第一个参数处对齐。 赋值语句的续行应在赋值号处对齐。 正例： if ((iFormat == CH_A_Format_M) && (iOfficeType == CH_BSC_M)) // 条件表达式的续行在第一个条件处对齐 { doSomething(); }
for (long_initialization_statement; long_condiction_statement; // for循环语句续行在初始化条件语句处对齐 long_update_statement) { doSomething(); }
// 函数声明的续行在第一个参数处对齐 BYTE ReportStatusCheckPara(HWND hWnd, BYTE ucCallNo, BYTE ucStatusReportNo);
// 赋值语句的续行应在赋值号处对齐 fTotalBill = fTotalBill + faCustomerPurchases[iID] + fSalesTax(faCustomerPurchases[iID]);
正例： extern double FAR CalcArea(double dWidth, double dHeight); 反例： extern double FAR CalcArea(double dWidth, double dHeight); 3. 注释注释有助于理解代码，有效的注释是指在代码的功能、意图层次上进行注释，提供有用、额外的信息，而不是代码表面意义的简单重复。
说明：注释的原则是有助于对程序的阅读理解，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。有效的注释是指在代码的功能、意图层次上进行注释，提供有用、额外的信息。
说明：对于特殊要求的可以使用英文注释，如工具不支持中文或国际化版本时。
说明：注释必须列出：版权信息、文件标识、内容摘要、版本号、作者、完成日期、修改信息等。修改记录部分建议在代码做了大修改之后添加修改记录。备注：文件名称，内容摘要，作者等部分一定要写清楚。 正例： 下面是文件头部的中文注释： /********************************************************************* * 版权所有 (C)2011中兴软件技术(南昌)有限公司 * * 文件名称： // 文件名 * 文件标识： // 见配置管理计划书 * 内容摘要： // 简要描述本文件的内容，包括主要模块、函数及其功能的说明 * 其它说明： // 其它内容的说明 * 当前版本： // 输入当前版本 * 作 者： // 输入作者名字及单位 * 完成日期： // 输入完成日期，例：2011年11月29日
* 修改记录1：// 修改历史记录，包括修改日期、修改者及修改内容 * 修改日期： * 版 本 号：//或版本号 * 修 改 人： * 修改内容：//修改原因以及修改内容说明 * 修改记录2：… **********************************************************************/
说明：注释必须列出：函数名称、功能描述、输入参数、输出参数、返 回 值、修改信息等。备注：方法名称、功能描述要正确描述。 正例： /*********************************************************************** * 方法名称： // 方法名称 * 功能描述： // 方法功能、性能等的描述 * 输入参数： // 输入参数说明，包括每个参数的作用、取值说明及参数间关系 * 输出参数： // 对输出参数的说明。 * 返 回 值： // 方法返回值的说明 * 其它说明： // 其它说明 ***********************************************************************/
说明：在使用缩写时或之前，应对缩写进行必要的说明。 正例： 如下书写比较结构清晰
/* 获得子系统索引 */ iSubSysIndex = aData[iIndex].iSysIndex;
/* 代码段1注释 */ [ 代码段1 ]
/* 代码段2注释 */ [ 代码段2 ] 反例1： 如下例子注释与描述的代码相隔太远。 /* 获得子系统索引 */
iSubSysIndex = aData[iIndex].iSysIndex; 反例2： 如下例子注释不应放在所描述的代码下面。
iSubSysIndex = aData[iIndex].iSysIndex; /* 获得子系统索引 */ 反例3： 如下例子，显得代码与注释过于紧凑。 /* 代码段1注释 */ [ 代码段1 ] /* 代码段2注释 */ [ 代码段2 ]
正例： /* * 变量作用说明 * 变量值说明 */ BYTE g_ucTranErrorCode;
说明：可使程序排版整齐，并方便注释的阅读与理解。 正例： 如下注释结构比较清晰 - (int)doSomething { /* 代码段1注释 */ [ 代码段1 ]
/* 代码段2注释 */ [ 代码段2 ] }
反例： 如下例子，排版不整齐，阅读不方便； int DoSomething(void) { /* 代码段1注释 */ [ 代码段1 ]
/* 代码段2注释 */ [ 代码段2 ] }
说明：在使用缩写时，应对缩写进行必要的说明。
4. 命名规则4.1.基本规则好的命名规则能极大地增加可读性和可维护性。同时，对于一个有上百个人共同完成的大项目来说，统一命名约定也是一项必不可少的内容。本章对程序中的所有标识符（包括变量名、常量名、函数名、类名、结构名、宏定义等）的命名做出约定。
说明：标识符应当直观且可以拼读，可望文知义，避免使人产生误解。程序中的英文单词一般不要太复杂，用词应当准确。
说明：这样做的目的是为了使程序易读。因为 variable_name 和 variable__name 很难区分，下划线符号‘_’若出现在标识符头或结尾，容易与不带下划线‘_’的标识符混淆。
正例：如 DISP_BUF_SIZE、MIN_VALUE、MAX_VALUE 等等。
说明：尽管局部变量和全局变量的作用域不同而不会发生语法错误，但容易使人误解。
说明：变量活动范围前缀规范如下（少用全局变量）： g_ ： 全局变量 s_ ： 模块内静态变量 空 ： 局部变量不加范围前缀
说明：方法名力求清晰、明了，通过方法名就能够判断方法的主要功能。方法名中不同意义字段之间不要用下划线连接，而要把每个字段的首字母大写以示区分。方法命名采用大小写字母结合的形式，但专有名词不受限制。
说明：参考匈牙利命名规则，常见的简写如下： 整型 n 指针 p 字符串 str 布尔 b 字符 c 函数 fn
正例： @interface CMainMenu { int m_nWidth; NString *m_strName; BOOL m_bCheck; }
说明：这样做的目的是为了代码的可重用性。
4.2.资源命名● 字符串：以“IDS_”开头，如：IDS_VIEW ● 图片：以“IDB_”开头，如：IDB_COREICON
5. 变量，常量，宏与类型变量、常量和数据类型是程序编写的基础，它们的正确使用直接关系到程序设计的成败，变量包括全局变量、局部变量和静态变量，常量包括数据常量和指针常量，类型包括系统的数据类型和自定义数据类型。本章主要说明变量、常量与类型使用时必须遵循的规则和一些需注意的建议，关于它们的命名，参见命名规则。 5.1.变量、常量以及宏
说明：一个变量只用来表示一个特定功能，不能把一个变量作多种用途，即同一变量取值不同时，其代表的意义也不同。
说明：循环语句只完成循环控制功能，if语句只完成逻辑判断功能，不能完成计算赋值功能。 正例： do { [处理语句] cInput = GetChar(); } while (cInput == 0); 反例： do { [处理语句] } while (cInput = GetChar());
说明：在宏定义中，对表达式和变量使用括号，可以避免可能发生的计算错误。 正例： #define HANDLE(A, B) (( A ) / ( B )) 反例： #define HANDLE(A, B) (A / B)
正例： #define BUTTON_WIDTH (int)320 反例： #define kButtonWidth (int)320
说明：不同的编译器，默认类型不一样。 正例： #define BUTTON_WIDTH (int)320 反例： #define BUTTON_WIDTH 320
说明：可以避免访问全局变量时引起的错误。 正例： T_Student g_tStudent; T_Student GetStudentValue(void) { T_Student tStudentValue; [获取g_tStudent的访问权] tStudentValue = g_tStudent; [释放g_tStudent的访问权] return tStudentValue; } BYTE SetStudentValue(const T_Student *ptStudentValue) { BYTE ucIfSuccess; ucIfSuccess = 0; [获取g_tStudent的访问权] g_tStudent = *ptStudentValue ; [释放g_tStudent的访问权] return ucIfSuccess; }
5.2.类型
说明：设计结构时应力争使结构代表一种现实事务的抽象，而不是同时代表多种。结构中的各元素应代表同一事务的不同侧面，而不应把描述没有关系或关系很弱的不同事务的元素放到同一结构中。 正例： typedef struct TeacherStruct { BYTE aucName[8]; BYTE ucSex; }T_Teacher;
typedef struct StudentStruct { BYTE ucName[8]; BYTE ucAge; BYTE ucSex; WORD wTeacherInd; }T_Student; 反例： 如下结构不太清晰、合理。 typedef struct StudentStruct { BYTE aucName[8]; BYTE ucAge; BYTE ucSex; BYTE aucTeacherName[8]; BYTE ucTeacherSex; }T_Student;
说明：合理排列结构中元素顺序，可节省空间并增加可理解性。 正例：如下形式，不仅可节省字节空间，可读性也变好了。 typedef struct ExampleStruct { BYTE ucValid; BYTE ucSetFlg; BYTE ucOther; // 保留位 T_Person tPerson; }T_Example; 反例：如下结构中的位域排列，将占较大空间，可读性也稍差。 typedef struct ExampleStruct { BYTE ucValid: 1; T_Person tPerson; BYTE ucSetFlg: 1; } T_Example;
6. 表达式与语句表达式是语句的一部分，它们是不可分割的。表达式和语句虽然看起来比较简单，但使用时隐患比较多。本章归纳了正确使用表达式和if、for、while、goto、switch等基本语句的一些规则与建议。
说明：复杂的语句阅读起来，难于理解，并容易隐含错误。变量定义时，一行只定义一个变量。 正例： int iHelp; int iBase; int iResult;
iHelp = iBase; iResult = iHelp + GetValue(&iBase); 反例： int iBase, iResult; // 一行定义多个变量
iResult = iBase + GetValue(&iBase); // 一条语句实现多个功能，iBase有两种用途。
说明：由于将运算符的优先级与结合律熟记是比较困难的，为了防止产生歧义并提高可读性，即使不加括号时运算顺序不会改变，也应当用括号确定表达式的操作顺序。 正例：
if (((iYear % 4 == 0) && (iYear % 100 != 0)) || (iYear % 400 == 0))
反例：
if (iYear % 4 == 0 && iYear % 100 != 0 || iYear % 400 == 0)
说明：带附加功能的表达式难于阅读和维护，它们常常导致错误。对于一个好的编译器，下面两种情况效果是一样的。 正例 ： aiVar[1] = aiVar[2] + aiVar[3]; aiVar[4]++; iResult = aiVar[1] + aiVar[4]; aiVar[3]++;
反例： iResult = (aiVar[1] = aiVar[2] + aiVar[3]++) + ++aiVar[4] ;
说明：TURE和FALSE的定义值是和语言环境相关的，且可能会被重定义的。 正例： 设bFlag 是布尔类型的变量 if (bFlag) // 表示flag为真 if (!bFlag) // 表示flag为假 反例： 设bFlag 是布尔类型的变量
if (bFlag == TRUE) if (bFlag == 1) if (bFlag == FALSE) if (bFlag == 0)
正例： if (iValue == 0)
if (iValue != 0)
反例： if (iValue) // 会让人误解 iValue是布尔变量
if (!iValue)
说明：无论是float还是double类型的变量，都有精度限制。所以一定要避免将浮点变量用“==”或“!=”与数字比较，应该转化成“>=”或“<=”形式。 正例： if ((fResult >= -EPSINON) && (fResult <= EPSINON)) 反例： if (fResult == 0.0) // 隐含错误的比较
其中EPSINON是允许的误差（即精度）。
说明：指针变量的零值是“空”（记为NULL），即使NULL的值与0相同，但是两者意义不同。 正例： if (pHead == nil) // pHead与NULL显式比较，强调pHead是指针变量 if (pHead != nil) 反例： if (pHead == 0) // 容易让人误解pHead是整型变量 if (pHead != 0) 或者 if (pHead) // 容易让人误解pHead是布尔变量 if (!pHead)
说明：避免漏掉break语句造成程序错误。同时保持程序简洁。 对于多个分支相同处理的情况可以共用一个break，但是要用注释加以说明。 正例： switch (iMessage) { case SPAN_ON: { [处理语句] break; } case SPAN_OFF: { [处理语句] break; } default: { [处理语句] break; } }
说明：保持程序简洁。如果需要判断的条件较多，建议用临时布尔变量先计算是否满足条件。 正例： BOOL bCondition;
do { …….. bCondition = ((tAp[iPortNo].bStateAcpActivity != PASSIVE) || (tAp[iPortNo].bStateLacpActivity != PASSIVE)) && (abLacpEnabled[iPortNo]) && (abPortEenabled[iPortNo])
} while (bCondition);
说明：下面两个示例中，反例比正例多执行了NUM -1次逻辑判断。并且由于前者总要进行逻辑判断，使得编译器不能对循环进行优化处理，降低了效率。如果NUM非常大，最好采用正例的写法，可以提高效率。 const int NUM = 100000; 正例: if (bCondition) { for (i = 0; i < NUM; i++) { doSomething(); } } else { for (i = 0; i < NUM; i++) { doOtherthing(); } }
反例: for (i = 0; i < NUM; i++) { if (bCondition) { DoSomething(); } else { DoOtherthing(); } }
说明：这样做更能适应c语言数组的特点，c语言的下标属于一个“半开半闭区间”。 正例： int aiScore[NUM]; … for (i = 0; i < NUM; i++) { printf(“%d\n”,aiScore[i]) } 反例： int aiScore[NUM]; … for (i = 0; i <= NUM-1; i++) { printf(“%d\n”,aiScore[i]); }
相比之下，正例的写法更加直观，尽管两者的功能是相同的。
7. 函数、方法、接口
正例： - (BOOL)sio_set_baud_rate:(int)arg; - (BOOL)sio_set_stop_bits(byte)arg; - (BOOL)sio_set_data_bits(byte)arg; - (BOOL)sio_get_baud_rate:(int *)arg; 反例： - (BOOL)sio_ ioctl:(void *)arg;
说明：如果参数太多，在使用时容易将参数类型或顺序搞错，而且调用的时候也不方便。如果参数的确比较多，而且输入的参数相互之间的关系比较紧密，不妨把这些参数定义成一个结构，然后把结构的指针当成参数输入。
说明：为了保证对被调用函数返回值的判断，有返回值的函数中的每一个退出点都需要有返回值。
说明：很多程序错误是由非法参数引起的，我们应该充分理解并正确处理来防止此类错误。
说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。
说明：多用途的函数往往通过在输入参数中有一个控制参数，根据不同的控制参数产生不同的功能。这种方式增加了函数之间的控制耦合性，而且在函数调用的时候，调用相同的一个函数却产生不同的效果，降低了代码的可读性，也不利于代码调试和维护。
说明：冗长的函数不利于调试，可读性差。
8. 头文件
说明：头文件中应避免包含其它不相关的头文件，一次头文件包含就相当于一次代码拷贝。
说明：正例： @class SubClassName； @interface ClassName : NSObject { SubClassName *m_pSubClassName; } 反例： #import “SubClassName.h”； @interface ClassName : NSObject { SubClassName *m_pSubClassName; }
9. 可靠性为保证代码的可靠性，编程时请遵循如下基本原则，优先级递减： ● 正确性，指程序要实现设计要求的功能。 ● 稳定性、安全性，指程序稳定、可靠、安全。 ● 可测试性，指程序要方便测试。 ● 规范/可读性，指程序书写风格、命名规则等要符合规范。 ● 全局效率，指软件系统的整体效率。 ● 局部效率，指某个模块/子模块/函数的本身效率。 ● 个人表达方式/个人方便性，指个人编程习惯。 9.1.内存使用
说明：内存操作主要是指对数组、指针、内存地址等的操作，内存操作越界是软件系统主要错误之一，后果往往非常严重，所以当我们进行这些操作时一定要仔细。 正例： const int MAX_USE_NUM = 10 // 用户号为1-10 unsigned char aucLoginFlg[MAX_USR_NUM + 1]={0, 0, 0, 0, 0, 0, 0, 0, 0, 0}; - (void)ArrayFunction { unsigned char ucUserNo; for (ucUserNo = 0; ucUserNo < MAX_USE_NUM; ucUserNo++) { aucLoginFlg[ucUser_No] = ucUserNo; … … } } 反例： const int MAX_USE_NUM = 10 // 用户号为1-10 unsigned char aucLoginFlg[MAX_USR_NUM]={0, 0, 0, 0, 0, 0, 0, 0, 0, 0}; - (void)ArrayFunction { unsigned char ucUserNo; for (ucUserNo = 1; ucUserNo < 11; ucUserNo++) // 10已经越界了 { aucLoginFlg[User_No] = ucUserNo; … … } }
说明：对嵌入式系统，通常内存是有限的，内存的申请可能会失败，如果不检查就对该指针进行操作，可能出现异常，而且这种异常不是每次都出现，比较难定位。 指针释放后，该指针可能还是指向原有的内存块，可能不是，变成一个野指针，一般用户不会对它再操作，但用户失误情况下对它的操作可能导致程序崩溃。 正例： - (void)memmoryFunction { unsigned char *pucBuffer = NULL; pucBuffer = GetBuffer(sizeof(DWORD)); if (NULL != pucBuffer) // 申请的内存指针必须进行有效性验证 { // 申请的内存使用前必须进行初始化 memset(pucBuffer, 0xFF, sizeof(DWORD)); } …. FreeBuffer(pucBuffer); // 申请的内存使用完毕必须释放 pucBuffer = NULL; // 申请的内存释放后指针置为空 … }
说明：不同的编译系统，定义的变量在初始化前其值是不确定的。有些系统会初始化为0，而有些不是。 9.2.指针使用
说明：指针加一的偏移，通常由指针的类型确定，如果通过复杂的逻辑或算术操作，则指针的位置就很难确定。
说明：尤其对全局变量赋值时，应进行合法性检查，以提高代码的可靠性、稳定性。
9.3.类
说明：除非在派生类中调用基类的赋值函数，否则基类变量不会自动被赋值。 正例： - (void)viewDidLoad { [super viewDidLoad]; }
正例： @interfaceClassName(Private)
- (void)test;
@end
- (void)test { }
10. 断言与错误处理断言是对某种假设条件进行检查（可理解为若条件成立则无动作，否则应报告）。它可以快速发现并定位软件问题，同时对系统错误进行自动报警。断言可以对在系统中隐藏很深，用其它手段极难发现的问题进行定位，从而缩短软件问题定位时间，提高系统的可测性。在实际应用时，可根据具体情况灵活地设计断言。
说明：整个软件系统提供一个统一的断言函数，如Assert(exp)， 同时可提供不同的宏进行定义（可根据具体情况灵活设计），如： （1）#define ASSERT_EXIT_M 中断当前程序执行，打印中断发生的文件、行号，该宏一般在单调时使用。 （2）#define ASSERT_CONTINUE_M 打印程序发生错误或异常的文件,行号,继续进行后续的操作，该宏一般在联调时使用。 （3）#define ASSERT_OK_M 空操作，程序发生错误情况时，继续进行，可以通过适当的方式通知后台的监控或统计程序，该宏一般在RELEASE版本中使用。
说明：加快软件运行速度。
说明：检查函数的输入参数是否合法，如输入参数为指针，则可用断言检查该指针是否为空，如输入参数为索引，则检查索引是否在值域范围内。 正例： BYTE StoreCsrMsg(WORD wIndex, T_CMServReq *ptMsgCSR) { WORD wStoreIndex; T_FuncRet tFuncRet;
Assert (wIndex < MAX_DATA_AREA_NUM_A); // 使用断言检查索引 Assert (ptMsgCSR != NULL); // 使用断言检查指针
… // 其它代码
return OK_M; }
11. 其它补充
正例： ViewBounds.size.height = VIEW_BOUNDS_HEIGHT; 反例： ViewBounds.size.height = 150; Height = 150;
正例： typedef enum { WIN_SIZE_NORMAL = 0, WIN_SIZE_SMALL }WinSize; 反例： typedef enum { WIN_SIZE_NORMAL, WIN_SIZE_SMALL }WinSize;
说明：应该要考虑多语言国际化，尽量使用NSLocalizedStringFromTable实现对字符串ID的引用
说明：代码实现窗体创建容易移植，优先考虑代码实现来替代xib实现
|
标签：
原文地址：http://www.cnblogs.com/yw2015/p/5008770.html
