一、前言
这篇重点介绍一下代码编程的排版风格和
自动排版工具，希望在编程方面能对大家有所帮助。
代码规范化中的排版基本上有七大风格，主要体现在缩进、空行、代码行、空格、成对书写、对齐、注释七方面的书写规范上。
二、规范要求
1、缩进
程序块采用缩进风格编写，缩进可以使程序更有层次感，每次缩进一般为 4 个空格（部分要求为一个制表符Tab；我个人喜欢用空格，因为制表符不同编辑器缩进不同，虽然能设置，但是麻烦）。
原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进
2、空行
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然在文档中比较多，但是值得。
-
定义变量后要空行。尽可能在定义变量的同时初始化该变量，即遵循就近原则；如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。
-
每个函数定义结束之后都要加空行。
-
结合1、2两点综合来说，相对独立的程序块之间、变量说明之后必须加空行。比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。
1isFoo = true;
2// 空行
3if (isFoo)
4{
5 bar();
6}
7else
8{
9 anotherBar();
10}
11// 空行
12isBar = false;
3、代码行
-
一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。
-
if
、
for
、
do
、
while
、
case
、
switch
、
default
等语句独占一行，执行语句不得紧跟其后。
不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。
-
一条语句不能过长，如不能拆分需要分行写，对于目前大多数的PC来说，132 比较合适（80/132是VTY常见的行宽值）。
对于新PC宽屏显示器较多的产品来说，可以设置更大的值; 且目前的软件大多都能设置并显示这个宽度的提示线。
1// 错误示范
2if (...){...}
3
4// 正确示范
5if (...)
6{
7 ...
8}
4、空格
-
关键字之后要留空格。像
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
和分号后面保留空格，
=
和
<
前后的空格去掉。
5、成对书写
成对的符号一定要成对书写，如
()
、
{}
。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。
6、对齐
对齐主要是针对大括号
{}
说的：
-
{
和
}
分别都要独占一行。互为一对的
{
和
}
要位于同一列，并且与引用它们的语句左对齐。
-
{
}
之内的代码要向内一个缩进，且同一地位的要左对齐，地位不同的继续缩进。
1
