代码风格(Coding Style)是一种习惯,养成良好的代码风格对保证程序的 质量至关重要,因为很多代码程序错误是由程序员的不良编程习惯引起的。
代码风格包括程序的版式、标识符命名、函数接口定义、文档等内容。
虽然程序的版式不会影响程序的功能,但却影响程序的可读性,它是保证代码整洁、层次清晰的主要手段。代码风格是最易获得和实践的软件工程规则。
一、代码行
1、一行内只写一条语句,一行代码之定义一个变量。这样的代码容易阅读,便于程序测试和写注释。
2、在定义变量的同时初始化改变量。这样可以避免变量的初始化被遗忘,或者引用未初始化的变量。
3、if、for、while、do等语句各自占一行,分支或循环体内的语句一律用“{”和“}”括起来,这样便于以后的代码维护。
二、对齐与缩进
1、程序的分界符“{”和“}”一般独占一行,且位于同一列,同时与引用它们的语句左对齐,这样便于查看“{”与“}”的配对情况。
2、采用阶梯层次对应好各层次,同层次的代码在同层次的缩进层上,即位于同一层“{”和“}”之内的代码在“{”右边数格处左对齐。
3、一般用设置为4个空格的Tab键缩进。现在的许多开发环境、编辑软件都支持自动缩进,即根据用户代码的输入,智能判断应该缩进还是反缩进,替用户完成调整缩进工作。
例如:在Visual C++编译环境中,只要选取需要的代码,按Alt+F8 可实现代码格式的自动整理。
三、空行及代码行内的空格
1、在每个函数定义结束后加一空行,能起到是程序布局更加美观、整洁和清晰的作用。
2、在一个函数体内,相邻的两组逻辑上密切相关的语句块之间加空行。
3、关键字之后加空格,以便突出关键字。
例如:关键字int、float等后面至少加一7 个空格;关键字if、for、while等后面一般只加一个空格。
4、函数名之后不加空格,紧跟左括号,以便与关键字相区别。
5、赋值、算术、关系、逻辑等运算符的前后各加一个空格,但一元运算符前后不加。
6、对表达式较长的for和if语句,为了紧凑,可在适当地方去掉一些空格。
例如:for(i=0;i<10;i++)
7、左圆括号向后紧跟,右圆括号、逗号和分号向前紧跟,紧跟出不留空格。
例如:Function(x,y,z)
8、函数参加的逗号分隔符和for中的分号后面加一个空格,可以增加单行的清晰度。
四、长行拆分
为了便于阅读,如果代码行太长,则要考虑在适当为止进行拆分,拆分出的新行要进行适当的缩进,是排版整齐。
五、程序注释
注释对于程序犹如眼睛对于人的重要性一样,程序越复杂,注释就越显得有价值。
没有注释的程序对于读者好比眼前一团漆黑。当然,注释并非越多越好,无意义和多余的注释如同垃圾,不但白写,还可能扰乱了读者的视线,甚至可能出现二义性,比不加注释还要糟糕。
1、在重要的程序文件的首部,对程序的功能、编程者、编程日期以及其他相关信息加以注释。
2、在用户自定义函数的前面,对函数接口加以注释说明。
3、在一些重要的语句行的右方,尤其是在语义转折处,对代码的功能、原理进行解释。
写注释时要注意:
(1)、注释不是白话文翻译,不要鹦鹉学舌。
(2)、不写做了什么,要写想做什么,如何做。
(3)、注释可长可短,但应画龙点睛,重点加在语义转折处。
(4)、边写代码边注释。
(5)、修改代码的同时也修改注释。
(6)、供别人使用的函数必须严格注释,特别是入口参数和出口参数,内部使用的函数以及某些简单的函数可以简单注释。