软件编程规范总则 注释 %25:注释格式尽量统一,建次使用“ %2-6:注释应考虑程序易读及外粥排版的因,使用的语言若是中、英兼有的,建议多使用中 文,除非船用非常流利准确的英文表达。 说明:注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用 中文。 仅供内部使用16
软件编程规范总则 2 注释 仅供内部使用 16 ½2-5：注释格式尽量统一，建议使用“/* …… */”。 ½2-6：注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中 文，除非能用非常流利准确的英文表达。 说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用 中文
软件编程规范总则 3标志符命名 3标识符命名 3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的 缩写,避兔使人产生误解。 说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成 缩写;一些单词有大家公认的缩写。 示例:如下单词的缩写能够被大家基本认可 temp可缩写为tmp f1ag可缩写为f1g statistic可缩写为stat increment可缩写为inc message可缩写为 3-2:命名中若使用特殊约定或缩写,则要有注释说明。 说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进 行必要的注释说明 13-3:自己特有的命名风格,要自始至终保持一致,不可来回变化 说明:个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即 命名规则中没有规定到的地方才可有个人命名风格)。 3-4:对于变量命名,禁止取单个字符(如i、jk..),建议除了要有具体含义外,还能 表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。 说明:变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编 译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。 示例:下面所示的局部变量名的定义方法可以借鉴 int liv width 其变量名解释如下: 局部变量(Loca1)(其它:g全局变量(G1oba1)...) i数据类型( Interger) 变量( Variab1e)(其它:c常量( Const)...) Width变量含义 仅供内部使用17
软件编程规范总则 3 标志符命名 仅供内部使用 17 3 标识符命名 ¹3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的 缩写，避免使人产生误解。 说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成 缩写；一些单词有大家公认的缩写。 示例：如下单词的缩写能够被大家基本认可。 temp 可缩写为 tmp ; flag 可缩写为 flg ; statistic 可缩写为 stat ; increment 可缩写为 inc ; message 可缩写为 msg ; ¹3-2：命名中若使用特殊约定或缩写，则要有注释说明。 说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进 行必要的注释说明。 ¹3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。 说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即 命名规则中没有规定到的地方才可有个人命名风格）。 ¹3-4：对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能 表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。 说明：变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如 i 写成 j），而编 译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。 示例：下面所示的局部变量名的定义方法可以借鉴。 int liv_Width 其变量名解释如下： l 局部变量（Local） （其它：g 全局变量（Global）...） i 数据类型（Interger） v 变量（Variable） （其它：c 常量（Const）...） Width 变量含义
软件编程规范总则 3标志符命名 这样可以防止局部变量与全局变量重名。 3-5:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNrx的 全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊 标识如标识成员变量或全局变量的m和g,其后加上大小写混排的方式是允许的。 示例: Add user不允许, add user、 Adduser、 m adduser允许。 31:除非必要,不要用数字或较奇怪的字符来定义标识符。 示例:如下命名,使人产生疑惑。 de fine EXAMPLE 0 TEST #de fine EXAMPLE 1 TEST void set slso0( BYTE sls 应改为有意义的单词命名 de fine EXAMPLE UNIT TEST de fine EXAMPLE ASSERT TEST void set udt msg sls( BYTE sls 3-2:在同一教件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名防 止编、链接时产生冲突。 说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常 量之前加上“模块”标识等。 33:用正确的反义词组命名具有互斥意义的变量成相反动作的函数等 说明:下面是一些在软件中常用的反义词组。 dd /remove begin /en create destroy insert delete first last get release increment / decrement add delete lock unlock open close min / max start stop next previous target show hide send receive source destination cut / paste up/ down 示例: ant min sun 仅供内部使用
软件编程规范总则 3 标志符命名 仅供内部使用 18 这样可以防止局部变量与全局变量重名。 ¹3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的 全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式，用作特殊 标识如标识成员变量或全局变量的m_和g_，其后加上大小写混排的方式是允许的。 示例： Add_User 不允许，add_user、AddUser、m_AddUser 允许。 ½3-1：除非必要，不要用数字或较奇怪的字符来定义标识符。 示例：如下命名，使人产生疑惑。 #define _EXAMPLE_0_TEST_ #define _EXAMPLE_1_TEST_ void set_sls00( BYTE sls ); 应改为有意义的单词命名 #define _EXAMPLE_UNIT_TEST_ #define _EXAMPLE_ASSERT_TEST_ void set_udt_msg_sls( BYTE sls ); ½3-2：在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防 止编译、链接时产生冲突。 说明：对接口部分的标识符应该有更严格限制，防止冲突。如可规定接口部分的变量与常 量之前加上“模块”标识等。 ½3-3：用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 说明：下面是一些在软件中常用的反义词组。 add / remove begin / end create / destroy insert / delete first / last get / release increment / decrement put / get add / delete lock / unlock open / close min / max old / new start / stop next / previous source / target show / hide send / receive source / destination cut / paste up / down 示例： int min_sum;
软件编程规范总则 3标志符命名 Int max sur int add user( bYTe *user name )i int delete user( bYte *user name )i %34:除了编开关/头文件等特殊应用,应避免使用 EXAMPLE VEST之类以下划线开始和 结尾的定义 仅供内部使用19
软件编程规范总则 3 标志符命名 仅供内部使用 19 int max_sum; int add_user( BYTE *user_name ); int delete_user( BYTE *user_name ); ½3-4：除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以下划线开始和 结尾的定义
软件编程规范总则 4可读性 可读性 4-1:注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。 说明:防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。 示例:下列语句中的表达式 if ((a b)&&(a &c) (2) if ((a b)<(c& d)) 如果书写为 b 由于 a b (1)(2)不会出错,但语句不易理解 a|b<c&d=a(b<c)sd,(3)造成了判断条件出错。 4-2:避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的 常量,不应直接使用数字,必须用有意义的枚举或宏来代替 示例:如下的程序可读性差。 if (Trunk[index]. trunk state == 0) Trunk[index]. trunk state =1 应改为如下形式。 #de fine TRUNK IDLe 0 de fine TRUNK BUSY 1 if (Trunklindex] trunk state = TRUNK IDle) Trunk [index]. trunk state TRUNK BUSY 仅供内部使用20
软件编程规范总则 4 可读性 仅供内部使用 20 4 可读性 ¹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 << 8) | low, a | b && a & c = (a | b) && (a & c)， (1)(2)不会出错，但语句不易理解； a | b < c & d = a | （b < c） & d，(3)造成了判断条件出错。 ¹4-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的 常量，不应直接使用数字，必须用有意义的枚举或宏来代替。 示例：如下的程序可读性差。 if (Trunk[index].trunk_state == 0) { Trunk[index].trunk_state = 1; ... // program code } 应改为如下形式。 #define TRUNK_IDLE 0 #define TRUNK_BUSY 1 if (Trunk[index].trunk_state == TRUNK_IDLE) { Trunk[index].trunk_state = TRUNK_BUSY;