Indent的学习笔记
Indent的学习笔记
最近在捣鼓Linux下的C编程,发现有不少东西可以学习和借鉴来辅助编程,这其中就有Indent。在网上搜了些资料来看,又翻了翻Indent的manual,综合起来写点自己的学习体会,以备日子久了自己复习查看。
1.Indent是干啥的?
简单来说,Indent可以对C语言的格式进行美化,提高代码的可读性,也可以在几种代码风格之间进行转换。
2.Indent如何调用?
调用格式如下:
indent [options] [input-files]
indent [options] [single-input-file] [-o output-file]
是不是很简单啊,还就是这么简单。找一个混乱的代码体会一下,怎一个爽字了得!
3.Indent的参数如何选?
看Indent调用里面的那个options了么,有不少可选的参数用来规范代码,下面我先挑主要的说。Indent默认的代码风格是的GNU范的,要是显示调用的话,选项使用-gnu即可(不写这个,直接调用也可以)。那这个-gnu到底包括哪些设置呢?
-gnu包括的参数设置如下:
-nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1 -cs -di2
-ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -nprs -psl -saf -sai
-saw -nsc -nsob
同理,Indent还预置了C语言圣经《The C Programming Language》中的Kernighan & Ritchie范代码风格。要是想采用这种风格,就要使用选项-kr,而-kr包括的参数设置如下:
-nbad -bap -bbo -nbc -br -brs -c33 -cd33 -ncdb -ce -ci4 -cli0
-cp33 -cs -d0 -di1 -nfc1 -nfca -hnl -i4 -ip0 -l75 -lp -npcs
-nprs -npsl -saf -sai -saw -nsc -nsob -nss
Indent还预置了Original Berkeley范的代码风格,可以采用选项-orig调用,-orig的参数设置包括如下:
-nbad -nbap -bbo -bc -br -brs -c33 -cd33 -cdb -ce -ci4 -cli0
-cp33 -di16 -fc1 -fca -hnl -i4 -ip4 -l75 -lp -npcs -nprs -psl
-saf -sai -saw -sc -nsob -nss -ts8
这些鬼扯的参数到底是什么意思?有兴趣的可以自己去查manual,里面都有比较详细的说明。引用一下网上搜来的资源,下表中列出了常见的几项。
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来缩进 |
4.如何简化参数输入?
如果不用默认提供的集中经典范,而是自己设置了一个绝美的style,但是每次都要悲催的敲一大堆option么?显然不用,可以通过在用户目录下/home/loser下创建一个.indent.pro文件,并将这些坑爹的选项全部扔进去,然后保存。之后,每次直接调用Indent就会默认采用.indent.pro中设置的技术青年范来美化你的代码了。
5.个人采用的参数?
由于本人代码风格诡谲多变,所以我现在还是尝试阶段,基本以K&R范为主吧。