编码规范

来源:互联网 发布:linux环境变量作用 编辑:程序博客网 时间:2024/05/21 18:43

编码规范

1、程序块要采用缩进风格编写,缩进的空格数为4个;

 

2、相对独立的程序块之间、变量说明之后必须加空行;

 

3、较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

 

4、循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首

 

5、若函数或过程中的参数较长,则要进行适当的划分

 

6、不允许把多个短语句写在一行中,即一行只写一条语句

 

7、if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}

 

8、对齐只使用空格键,不使用TAB键

 

9、函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求

 

10、程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式

 

11、在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格

说明:采用这种松散方式编写代码的目的是使代码更加清晰

由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格。

如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在C/C++语言中括号已经是最清晰的标志了。

在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。

(1) 逗号、分号只在后面加空格

(2) 比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格

(3) "!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格

(4) "->"、"."前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显

 

12、一行程序以小于80字符为宜,不要写得过长

 

 

编码规范的意义和作用

1、好的编码规范可以尽可能的减少一个软件的维护成本 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;

 

2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;

 

3、好的编码规范可以最大限度的提高团队开发的合作效率;

 

4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;

 

0 0