软件编程规范总则2

编程规范总则2

 

标识符命名：

                                 1、标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的编写，避免使人产生误解。

• • • •      说明：  较短的单词可通过去掉“元音” 形成缩写；较长的单词可取单词的头几个字母形成。
      •      缩写： 一些单词有大家公认的缩写。例如：                                                    

                                              

                                             

                                2、命名中若使用特殊约定或是缩写，则要有注释说明。

• • • •     说明：应该在源文件的开始之处，对文件中所使用的缩写或是约定，特别是特殊的缩写，进行必要的注释说 明。                                              

                                 3、自己特有的命名风格，要自始至终保持一致，不可来回变化。

• • • •     说明：在符合所在项目组或产品组的命名规则的前提下，才可以使用。

                                 4、对于变量命名，禁止取单个字符（如i、j、k······是作局部循环是允许的），建议除了要有具体含义外，还能表明其变量类型、数据类型等。

 

                         5、命名规范必须与所使用的系统风格保持一致，并在同一项目中统一；除非必要，不要用数字或比较奇怪的字符来定义标识符。

 

                                6、在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量），防止编译、链接时产生冲突。

 

                                7、用正确的反义词组命名具有互斥的变量或相反动作的函数等。例如：

                                         

 

可读性：

                   1、注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。例如：

                                

 

                         2、避免使用不易理解的数字，用有意义的标识符来代替。涉及物理状态或者有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

 

                                3、源程序中关系较为紧密的代码应尽可能相邻。例如：

                                   

 

                         4、不要使用难懂的技巧性很高的语句，除非很有必要时。

• • • • 说明：高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。