代码编程规范分析.ppt

2-10 ：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明 示例： /* The ErrorCode when SCCP translate */ /* Global Title failure, as follows */ // 变量作用、含义 /* 0 － SUCCESS 1 － GT Table error */ /* 2 － GT error Others － no use */ // 变量取值范围 /* only function SCCPTranslate() in */ /* this modual can modify it, and other */ /* module can visit it through call */ /* the function GetGTTransErrorCode() */ // 使用方法 BYTE g_GTTranErrorCode; * 2-11 ：注释与所描述内容进行同样的缩排 说明：可使程序排版整齐，并方便注释的阅读与理解。 示例：如下例子，排版不整齐，阅读稍感不方便。 void example_fun( void ) { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } 应改为如下布局。 void example_fun( void ) { /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two } * 2-12 ：在程序块的结束行右方加注释标记，以表明某程序块的结束 说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。 示例：参见如下例子。 if (...) { // program code while (index MAX_INDEX) { // program code } /* end of while (index MAX_INDEX) */ // 指明该条while语句结束 * 1、排版 2、注释 3、标识符命名 4、可读性 5、变量、结构 6、函数、过程 * 3-1 ：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解 说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。 示例：如下单词的缩写能够被大家基本认可。 temp 可缩写为 tmp ; flag 可缩写为 flg ; statistic 可缩写为 stat ; increment 可缩写为 inc ; message 可缩写为 msg ; * 3-2 ：对于变量命名，禁止取单个字符（如i 、j 、k... ），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i 、j 、k 作局部循环变量是允许的 说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。 示例：下面所示的局部变量名的定义方法可以借鉴。 int liv_Width 其变量名解释如下： l 局部变量（Local） （其它：g 全局变量（Global）...） i 数据类型（Interger） v 变量（Variable） （其它：c 常量（Const）...） Width 变量含义 这样可以防止局部变量与全局变量重名。 * 1、排版 2、注释 3、标识符命名 4、可读性 5、变量、结构 6、函数、过程 * 4-1 ：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级 说明：防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。 示例：下列语句中的表达式 word = (high 8) | low (1) if ((a | b) (a c)) (2) if ((a | b) (c d)) (3) 如果书写为: high 8 | low a | b a c a | b c d 由于 high 8 | low = ( high