indent 格式化C源代码

作用

indent 可识别 C 的原代码文件,并加以格式化,以方便程序设阅读。

语法

indent [参数][源文件]
indent [参数][源文件][-o 目标文件]

参数

  • -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  显示版本信息。

indent 代码格式化说明:

使用的indent参数含义
--blank-lines-after-declarationsbad变量声明后加空行
--blank-lines-after-proceduresbap函数结束后加空行
--blank-lines-before-block-commentsbbb块注释前加空行
--break-before-boolean-operatorbbo较长的行,在逻辑运算符前分行
--blank-lines-after-commasnbc变量声明中,逗号分隔的变量不分行
--braces-after-if-linebl"if"和"{"分做两行
--brace-indent 0bli0"{"不继续缩进
--braces-after-struct-decl-linebls定义结构,"struct"和"{"分行
--comment-indentationnc33语句后注释开始于行33
--declaration-comment-columnncd33变量声明后注释开始于行33
--comment-delimiters-on-blank-linesncdb不将单行注释变为块注释
--cuddle-do-whilencdw"do --- while"的"while"和其前面的"}"另起一行
--cuddle-elsence"else"和其前面的"}"另起一行
--case-indentation 0cli0switch中的case语句所进0个空格
--else-endif-columnncp33#else, #endif后面的注释开始于行33
--space-after-castcs在类型转换后面加空格
--line-comments-indentation nd0单行注释(不从1列开始的),不向左缩进
--break-function-decl-argsnbfda关闭:函数的参数一个一行
--declaration-indentationndi2变量声明,变量开始于2行,即不必对齐
--format-first-column-commentsnfc1不格式化起于第一行的注释
--format-all-commentsnfca不开启全部格式化注释的开关
--honour-newlineshnlPrefer to break long lines at the position of newlines in the input.
--indent-levelni4设置缩进多少字符,如果为tab的整数倍,用tab来缩进,否则用空格填充。
--parameter-indentationnip5旧风格的函数定义中参数说明缩进5个空格
--line-length 75l75非注释行最长75
--continue-at-parentheseslp续行从上一行出现的括号开始
--space-after-procedure-callspcs函数和"("之间插入一个空格
--space-after-parenthesesnprs在"("后")"前不插入空格
--procnames-start-linespsl将函数名和返回类型放在两行定义
--space-after-forsaffor后面有空格
--space-after-ifsaiif后面有空格
--space-after-whilesawwhile后面有空格
--start-left-side-of-commentsnsc不在生成的块注释中加*
--swallow-optional-blank-linesnsob不去掉可添加的空行
--space-special-semicolonnss一行的for或while语句,在";"前不加空。
--tab-sizets4一个tab为4个空格(要能整除"-in")
--use-tabsut使用tab来缩进

示例

该示例展示怎样使用 index 命令对 c 源码进行格式化,命令如下:

hxstrive@hxstrive:~$ cat test.c
#include <stdio.h>
#include <ctype.h>

int main() {
char c1 = 'A';
char c2 = ' ';
printf("isalnum(c1) = %d\n", isalnum(c1));
printf("isalnum(c2) = %d\n", isalnum(c2));
return 0;
}

hxstrive@hxstrive:~$ indent test.c

hxstrive@hxstrive:~$ cat test.c
#include <stdio.h>
#include <ctype.h>

int
main ()
{
  char c1 = 'A';
  char c2 = ' ';
  printf ("isalnum(c1) = %d\n", isalnum (c1));
  printf ("isalnum(c2) = %d\n", isalnum (c2));
  return 0;
}

可以看到,格式化后的代码更加易读。

更多关于命令详细参考手册,请使用 man 命令或者 --help 参数获取帮助信息

关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号