如果你觉得该文章对你有帮助,欢迎点赞+关注
这篇重点介绍一下代码编程的排版风格和自动排版工具
代码规范化中的排版基本上有七大风格,主要体现在缩进、空行、代码行、空格、成对书写、对齐、注释七方面的书写规范上。
程序块采用缩进风格编写,缩进可以使程序更有层次感,每次缩进一般为 4 个空格(部分要求为一个制表符Tab;我个人喜欢用空格,因为制表符不同编辑器缩进不同,虽然能设置,但是麻烦)
原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存,虽然在文档中比较多,但是值得
定义变量后要空行。尽可能在定义变量的同时初始化该变量,即遵循就近原则;如果变量的引用和定义相隔比较远,那么变量的初始化就很容易被忘记。若引用了未被初始化的变量,就会导致程序出错
每个函数定义结束之后都要加空行
结合1、2两点综合来说,相对独立的程序块之间、变量说明之后必须加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰
1isFoo = true;
2// 空行
3if (isFoo)
4{
5 bar();
6}
7else
8{
9 anotherBar();
10}
11// 空行
12isBar = false;
一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释
if
、for
、do
、while
、case
、switch
、default
等语句独占一行,执行语句不得紧跟其后
不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误
一条语句不能过长,如不能拆分需要分行写,对于目前大多数的PC来说,132 比较合适(80/132是VTY常见的行宽值)
对于新PC宽屏显示器较多的产品来说,可以设置更大的值; 且目前的软件大多都能设置并显示这个宽度的提示线
1// 错误示范
2if (...){...}
3
4// 正确示范
5if (...)
6{
7 ...
8}
关键字之后要留空格。像 const
、case
等关键字之后至少要留一个空格,否则无法辨析关键字。像 if
、for
、while
等关键字之后应留一个空格再跟左括号(
,以突出关键字
1// 错误示范
2if(...)
3
4// 正确示范
5if (...)
函数名之后不要留空格,应紧跟左括号(
,以与关键字区别
1// 错误示范
2void move (char *buf, uint32_t length);
3
4// 正确示范
5void move(char *buf, uint32_t length);
(
向后紧跟;)
、,
、;
这三个向前紧跟;紧跟处不留空格
1// 错误示范
2move ( buf , 35 ) ;
3
4// 正确示范
5move(buf, 35);
,
之后要留空格。如果;不是一行的结束符号,其后要留空格
1// 错误示范
2move(buf,35);
3
4// 正确示范
5move(buf, 35);
赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =
、==
、!=
、+=
、-=
、=`、`/=`、`%=`、`>>=`、`<<=`、`&=`、`^=`、`|=`、`<`、`<=`、`>`、`>=`、`+`、`-`、`
、/
、%
、&;
、|
、&&
、||
、<<、>>;
、^
等双目运算符的前后应当加空格(运算符“%”是求余运算符,与 printf
中 %d
的“%”
不同,所以 %d
中的“%”
前后不用加空格)
1// 错误示范
2num+=5;
3hex=hex&0x05;
4printf("% d", num);
5
6// 正确示范
7num += 5;
8hex = hex & 0x05;
9printf("%d", num);
单目运算符 !
、~
、++
、--
、-
、*
、&
等前后不需要加空格
1// 错误示范
2cnt ++;
3boolVal = ! boolVal;
4
5// 正确示范
6cnt++;
7boolVal = !boolVal;
像数组符号[]
、结构体成员运算符.
、和指向结构体成员运算符->
,这类操作符前后不加空格
1// 错误示范
2char buf [ 50 ];
3tInfo -> mem = 0;
4
5// 正确示范
6char buf[50];
7tInfo->mem = 0;
对于表达式比较长的for
语句和if
语句,为了紧凑起见,可以适当地去掉一些空格。但 for
和 if
后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。例如:for (i=0; i<10; i++)
,即for
和分号后面保留空格,=
和 <
前后的空格去掉
成对的符号一定要成对书写,如 ()
、{}
。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。
对齐主要是针对大括号{}
说的
{
和 }
分别都要独占一行。互为一对的{
和}
要位于同一列,并且与引用它们的语句左对齐
{
}
之内的代码要向内一个缩进,且同一地位的要左对齐,地位不同的继续缩进
1// 错误示范
2int main(void){
3int val = 0;
4}
5
6// 正确示范
7// 错误示范
8int main(void)
9{
10 int val = 0;
11}
C语言中一行注释一般采用//…
,多行注释必须采用 /*…*/
。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释,注释太多会让人眼花缭乱。
注释用使用对代码的功能做解释,并不是说明是怎么做的
对于一些巧妙地、用特殊方式实现功能的代码,可以使用注释说明这样做的目的或好处等
代码十分明确的,一目了然的,则不必增加注释,否则就是多余的注释,如 int minValue = 5; // 定义最小值为5
边写代码边注释,修改代码的同时要修改相应的注释,以保证注释与代码的一致性,不再有用的注释要删除
每一条宏定义的右边必须要有注释,说明其作用
相关函数和结构体等需要注释,具体注释方式请参考文档中的“注释规范”内容
嵌入式软件开发常用软件中提到的源格式化工具Astyle,官网地址http://astyle.sourceforge.net/
Astyle 是一个开源的源码格式化工具插件,可以集成在 KEIL、IAR 或者文本编辑器等多款软件中,作为一个脚本自动格式话代码风格,十分方便。
根据上述排版风格,我设置的指令是:--style=allman -t -xV -C -f -p -H -k3 -y -xb -j -U %f
如下图,随便打开一个糟糕的代码文件,通过 KEIL 集成的 Astyle工具自动格式化代码风格。
来源:大橙子疯嵌入式