目的
为形成自己的C++编码风格,以保障代码的易维护性和编码安全性,特制定本规范。
1 程序的版式
1.程序块要采用缩进风格编写 :程序块要采用缩进风格编写,缩进的空格数为 ,缩进的空格数为 4 个。
2.规则:相对独立的程序块之间 :相对独立的程序块之间、变量说明之后必须加空行 、变量说明之后必须加空行。
3.较长的语句(>80 字符)要分成多行书写 )要分成多行书写。
4.不允许把多个短语句写在一行中 :不允许把多个短语句写在一行中,即一行只写一条语句 ,即一行只写一条语句。
5.规则:代码行之内应该留有适当的空格 :代码行之内应该留有适当的空格
6 . 建议:程序块的分界符 :程序块的分界符(如 C/C++语言的大括号‘{’和‘}’)应各独占一行并且 应各独占一行并且 位于同一列,同时与引用它们的语句左对齐 ,同时与引用它们的语句左对齐。在函数体的开始 。在函数体的开始、类的定义、结构的定义、 枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩 语句中的程序都要采用如上的缩 进方式。
2.注释
1.规则:源文件头部应进行注释 :源文件头部应进行注释,列出:生成日期、作者、模块目的/功能等。
2.规则:函数头部应进行注释 :函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回 值等。
3.建议:注释的主要目的应该是解释为什么这么做 :注释的主要目的应该是解释为什么这么做,而不是正在做什么 ,而不是正在做什么。如果从上下 文不容易看出作者的目的,说明程序的可读性本身存在比较大的问题 ,说明程序的可读性本身存在比较大的问题,应考虑对其重构 ,应考虑对其重构。 5.7 建议:避免非必要的注释 :避免非必要的注释。
3.标识符命名
1.规则:命名尽量使用英文单词 :命名尽量使用英文单词,力求简单清楚 ,力求简单清楚,避免使用引起误解的词汇和模糊的 ,避免使用引起误解的词汇和模糊的 缩写,使人产生误解 ,使人产生误解。
2.建议:变量的命名可参考 :变量的命名可参考“匈牙利”标记法(Hungarian Notation (Hungarian Notation Hungarian Notation):TypePrefix+ Name
|