当我们编写程序时,同一个程序代码不同的人编写出来给人的感觉就不一样;其中一个很大的区别就在于c语言的代码规范的把握。
要打好一个规范美观的代码,主要是以下几个方面要注意:
1.排版:
程序快要采取缩进风格编写,缩进的空格数一般为4位;
相对独立的语句块,变量说明后要加空行;
程序块的分界符如(“{”和“}”)应各自独占一行,并处于同一列,同时引用它们的语句左对齐;
不要把多个短语句写在同一行,即一行只写一个语句;
if for do while case switch default 等语句要各自占一行,且if for do while等语句的执行部分不论语句的多少都要加 {};
例如:if (a > b) I++;
应该改为:
if (a > b)
{
I++;
}
较长的语句(>80字符)要分成多行写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分成的新行要作适当的缩进,使排版整齐,语句可读;
2.注释:
注释必须做到清晰,准确地描述内容。对于程序中复杂的部分必须有注释加以说明。注释量要适中,过多或过少都易导致阅读困难。
文件头部应进行注释,主是必须列出版权说明,版本号,生成日期,作者,内容,功能,修改。。。等
C语言中使用一组(/* … */)作为注释界定符。
注释内容尽量用英语方式表述。
注释的基本样式参考范例4。
注释应该出现在要说明的内容之前,而不应该出现在其后。
除了说明变量的用途和语言块末尾使用的注释,尽量不使用行末的注释方式
3.命名规范:
符号常量的命名用大写字母表示;
如果符号常量由多个单词构成,两个不同的单词之间可以用下划线连接。如:
#define MAX_LEN 50
变量命名的基本原则:
可以选择有意义的英文(小写字母)组成变量名,使人看到该变量就能大致清楚其含义。
不要使用人名、地名和汉语拼音。
如果使用缩写,应该使用那些约定俗成的,而不是自己编造的。
多个单词组成的变量名,除第一个单词外的其他单词首字母应该大写。
4.其它一些小技巧和要求:
函数一般情况下应该少于100行
函数定义一定要包含返回类型,没有返回类型加void
写比较表达式时,将常量放在左边
10 == n
NULL != pInt
指针变量总是要初始或重置为NULL
使用{}包含复合语句,即使是只有一行,如:
if (1 == a)
{
x = 5;
}