2012年(77)
分类:
2012-05-24 20:20:51
原文地址:indent工具 作者:
The indent program can be used to make code easier to read. It can also convert from one style of writing C to another. indent understands a substantial amount about the syntax of C, but it also attempts to cope with incomplete and misformed syntax.
indent工具自动统一代码风格:
indent -gnu style.c -o style_gnu.c //变成gnu风格
indent -kr -i8 style.c -o style_kernel.c //变成内核风格
indent -kr -i8 style.c //直接在原文件上修改
-kr选项表示K&R风格,-i8表示缩进8个空格的长度。如果没有指定-nut选项,则每8个缩进空格会
自动用一个Tab代替。
两大风格:
GNU编程风格-> 要点:
函数开头的左花括号在最左边,其他的左括号避免放到最左边;
函数名的起始字符也要在最左边;
每个程序开头都要有一段注释说明其功能;
函数的注释:功能,参数类型,含义,返回值;
while,if尽量带上括号;
避免在if中赋值;
结构的声明和typedef,结构变量定义尽可能不放一起;
全局变量要注释;
全局变量和函数,避免采用简单的名字,小写字母加下划线构成;
局部变量命名要简短;
kernel编程风格-> 要点:
缩进格式是tab,缺省是8字符;
函数长度不应超过2屏(24*2);函数局部变量不应超过10个;
将开始的大括号放在一行的最后,函数定义除外;
结束的大括号通常单独位于一行,下列情况除外:
do {
}while();
if () {
}else if () {
}else{
}
常用的设置:
indent -npro -kr -i8 -ts8 -sob -l80 -ss -bl -bli 0
参数说明:
-npro或--ignore-profile 不要读取indent的配置文件.indent.pro。
-kr 指定使用Kernighan&Ritchie的格式。
-i8 --indent-level 设置缩排的格数为8,可以修改。
-ts8 设置tab的长度
-sob或--swallow-optional-blank-lines 删除多余的空白行。
-l80 代码超过80换行
-ss或--space-special-semicolon 若for区段只有一行时,在分号前加上空格。
-ncs或--no-space-after-casts 不要在cast之后空一格。
-bl {分行显示
-bli 0 括号缩进为0
功能说明:调整C原始代码文件的格式。
语 法:indent [参数][源文件] 或 indent [参数][源文件][-o 目标文件]
补充说明:indent可辨识C的原始代码文件,并加以格式化,以方便程序设计师阅读。
参 数:
-bad或--blank-lines-after-declarations 在声明区段或加上空白行。
-bap或--blank-lines-after-procedures 在程序或加上空白行。
-bbb或--blank-lines-after-block-comments 在注释区段后加上空白行。
-bc或--blank-lines-after-commas 在声明区段中,若出现逗号即换行。
-bl或--braces-after-if-line if(或是else,for等等)与后面执行区段的"{"不同行,且"}"自成一行。
-bli<缩排格数>或--brace-indent<缩排格数> 设置{ }缩排的格数。
-br或--braces-on-if-line if(或是else,for等等)与后面执行跛段的"{"不同行,且"}"自成一行。
-bs或--blank-before-sizeof 在sizeof之后空一格。
-c<栏数>或--comment-indentation<栏数> 将注释置于程序码右侧指定的栏位。
-cd<栏数>或--declaration-comment-column<栏数> 将注释置于声明右侧指定的栏位。
-cdb或--comment-delimiters-on-blank-lines 注释符号自成一行。
-ce或--cuddle-else 将else置于"}"(if执行区段的结尾)之后。
-ci<缩排格数>或--continuation-indentation<缩排格数> 叙述过长而换行时,指定换行后缩排的格数。
-cli<缩排格数>或--case-indentation-<缩排格数> 使用case时,switch缩排的格数。
-cp<栏数>或-else-endif-column<栏数> 将注释置于else与elseif叙述右侧定的栏位。
-cs或--space-after-cast 在cast之后空一格。
-d<缩排格数>或-line-comments-indentation<缩排格数> 针对不是放在程序码右侧的注释,设置其缩排格数。
-di<栏数>或--declaration-indentation<栏数> 将声明区段的变量置于指定的栏位。
-fc1或--format-first-column-comments 针对放在每行最前端的注释,设置其格式。
-fca或--format-all-comments 设置所有注释的格式。
-gnu或--gnu-style. 指定使用GNU的格式,此为预设值。
-i<格数>或--indent-level<格数> 设置缩排的格数。
-ip<格数>或--parameter-indentation<格数> 设置参数的缩排格数。
-kr或--k-and-r-style. 指定使用Kernighan&Ritchie的格式。
-lp或--continue-at-parentheses 叙述过长而换行,且叙述中包含了括弧时,将括弧中的每行起始栏位内容垂直对其排列。
-nbad或--no-blank-lines-after-declarations 在声明区段后不要加上空白行。
-nbap或--no-blank-lines-after-procedures 在程序后不要加上空白行。
-nbbb或--no-blank-lines-after-block-comments 在注释区段后不要加上空白行。
-nbc或--no-blank-lines-after-commas 在声明区段中,即使出现逗号,仍旧不要换行。
-ncdb或--no-comment-delimiters-on-blank-lines 注释符号不要自成一行。
-nce或--dont-cuddle-else 不要将else置于"}"之后。
-ncs或--no-space-after-casts 不要在cast之后空一格。
-nfc1或--dont-format-first-column-comments 不要格式化放在每行最前端的注释。
-nfca或--dont-format-comments 不要格式化任何的注释。
-nip或--no-parameter-indentation 参数不要缩排。
-nlp或--dont-line-up-parentheses 叙述过长而换行,且叙述中包含了括弧时,不用将括弧中的每行起始栏位垂直对其排列。
-npcs或--no-space-after-function-call-names 在调用的函数名称之后,不要加上空格。
-npro或--ignore-profile 不要读取indent的配置文件.indent.pro。
-npsl或--dont-break-procedure-type 程序类型与程序名称放在同一行。
-nsc或--dont-star-comments 注解左侧不要加上星号(*)。
-nsob或--leave-optional-semicolon 不用处理多余的空白行。
-nss或--dont-space-special-semicolon 若for或while区段仅有一行时,在分号前不加上空格。
-nv或--no-verbosity 不显示详细的信息。
-orig或--original 使用Berkeley的格式。
-pcs或--space-after-procedure-calls 在调用的函数名称与"{"之间加上空格。
-psl或--procnames-start-lines 程序类型置于程序名称的前一行。
-sc或--start-left-side-of-comments 在每行注释左侧加上星号(*)。
-sob或--swallow-optional-blank-lines 删除多余的空白行。
-ss或--space-special-semicolon 若for或swile区段今有一行时,在分号前加上空格。
-st或--standard-output 将结果显示在标准输出设备。
-T 数据类型名称缩排。
-ts<格数>或--tab-size<格数> 设置tab的长度。
-v或--verbose 执行时显示详细的信息。
-version 显示版本信息