用 indent 进行代码格式化

Indent参数规范

我们参照GNU，Kernighan & Ritchie，Berkeley风格，制定了自己风格：

1. indent命令参数：

   -bad -bap -bbb -bbo -nbc -bl -bli0 -bls -c33 -cd33 -ncdb -ncdw -nce -cli0 -cp33 -cs -d0 -nbfda -di2 -nfc1 -nfca -hnl -ip5 -l75 -lp -pcs -nprs -psl -saf -sai -saw -nsc -nsob -nss -i4 -ts4 -ut

2. indent配置文件

   如上参数可写入用户目录下的文件：".indent.pro"，作为运行indent的确省参数。

3. indent配置说明

   表 1. Indent代码格式化说明

   使用的indent参数	值	含义
   --blank-lines-after-declarations	bad	变量声明后加空行
   --blank-lines-after-procedures	bap	函数结束后加空行
   --blank-lines-before-block-comments	bbb	块注释前加空行
   --break-before-boolean-operator	bbo	较长的行，在逻辑运算符前分行
   --blank-lines-after-commas	nbc	变量声明中，逗号分隔的变量不分行
   --braces-after-if-line	bl	"if"和"{"分做两行
   --brace-indent 0	bli0	"{"不继续缩进
   --braces-after-struct-decl-line	bls	定义结构，"struct"和"{"分行
   --comment-indentationn	c33	语句后注释开始于行33
   --declaration-comment-columnn	cd33	变量声明后注释开始于行33
   --comment-delimiters-on-blank-lines	ncdb	不将单行注释变为块注释
   --cuddle-do-while	ncdw	"do --- while"的"while"和其前面的"}"另起一行
   --cuddle-else	nce	"else"和其前面的"}"另起一行
   --case-indentation 0	cli0	switch中的case语句所进0个空格
   --else-endif-columnn	cp33	#else, #endif后面的注释开始于行33
   --space-after-cast	cs	在类型转换后面加空格
   --line-comments-indentation n	d0	单行注释（不从1列开始的），不向左缩进
   --break-function-decl-args	nbfda	关闭：函数的参数一个一行
   --declaration-indentationn	di2	变量声明，变量开始于2行，即不必对齐
   --format-first-column-comments	nfc1	不格式化起于第一行的注释
   --format-all-comments	nfca	不开启全部格式化注释的开关
   --honour-newlines	hnl	Prefer to break long lines at the position of newlines in the input.
   --indent-leveln	i4	设置缩进多少字符，如果为tab的整数倍，用tab来缩进，否则用空格填充。
   --parameter-indentationn	ip5	旧风格的函数定义中参数说明缩进5个空格
   --line-length 75	l75	非注释行最长75
   --continue-at-parentheses	lp	续行从上一行出现的括号开始
   --space-after-procedure-calls	pcs	函数和"("之间插入一个空格
   --space-after-parentheses	nprs	在"（"后"）"前不插入空格
   --procnames-start-lines	psl	将函数名和返回类型放在两行定义
   --space-after-for	saf	for后面有空格
   --space-after-if	sai	if后面有空格
   --space-after-while	saw	while后面有空格
   --start-left-side-of-comments	nsc	不在生成的块注释中加*
   --swallow-optional-blank-lines	nsob	不去掉可添加的空行
   --space-special-semicolon	nss	一行的for或while语句，在";"前不加空。
   --tab-size	ts4	一个tab为4个空格（要能整除"-in"）
   --use-tabs	ut	使用tab来缩进

indent工具

indent工具可以把代码格式化成某种风格，例如把格式化成内核编码风格：

$ indent -kr -i8 main.c 
$ cat main.c
#include 
#include 
#include 
int main(void)
{
	char gesture[3][10] = { "scissor", "stone", "cloth" };
	int man, computer, result, ret;
	srand(time(NULL));
	while (1) {
		computer = rand() % 3;
		printf
		    ("\nInput your gesture (0-scissor 1-stone 2-cloth):\n");
		ret = scanf("%d", &man);
		if (ret != 1 || man < 0 || man > 2) {
			printf("Invalid input!\n");
			return 1;
		}
		printf("Your gesture: %s\tComputer's gesture: %s\n",
		       gesture[man], gesture[computer]);
		result = (man - computer + 4) % 3 - 1;
		if (result > 0)
			printf("You win!\n");
		else if (result == 0)
			printf("Draw!\n");
		else
			printf("You lose!\n");
	}
	return 0;
}

-kr选项表示K&R风格，-i8表示缩进8个空格的长度。如果没有指定-nut选项，则每8个缩进空格会自动用一个Tab代替。注意indent命令会直接修改原文件，而不是打印到屏幕上或者输出到另一个文件，这一点和很多UNIX命令不同。可以看出，-kr -i8两个选项格式化出来的代码已经很符合本章介绍的代码风格了，添加了必要的缩进和空白，较长的代码行也会自动折行。美中不足的是没有添加适当的空行，因为indent工具也不知道哪几行代码在逻辑上是一组的，空行还是要自己动手添，当然原有的空行肯定不会被indent删去的。

如果你采纳本章介绍的内核编码风格，基本上-kr -i8这两个参数就够用了。indent工具也有支持其它编码风格的选项，具体请参考Man Page。有时候indent工具的确非常有用，比如某个项目中途决定改变编码风格（这很少见），或者往某个项目中添加的几个代码文件来自另一个编码风格不同的项目，但绝不能因为有了indent工具就肆无忌惮，一开始把代码写得乱七八糟，最后再依靠indent去清理。