Linux indent命令 (格式化C语言源代码的程序)

简介: Linux indent命令 (格式化C语言源代码的程序)

Linux indent命令

* 概述

indent是一个常用的在Linux和UNIX系统中用于格式化C语言源代码的程序,而不是shell命令indent可以将源代码按照一定的格式标准或者用户自定义的格式进行排版,使得代码的可读性更强。

例如,你可以使用以下命令将一个C语言源文件进行格式化:

indent -kr -i8 -ts8 -sob -l80 -ss -ncs file.c

这条命令中的选项有以下含义:

  • -kr: 使用Kernighan & Ritchie 格式(这是C语言的创始人的名字)。
  • -i8: 设置缩进级别为8个空格。
  • -ts8: 设置制

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

indent 是一个可执行文件,而不是 shell 内置命令。它是由一个源代码文件编译而来的,包含了一些可执行的二进制代码。当你在命令行中输入 indent 并按下回车键时,操作系统会在你的 PATH 环境变量指定的目录中查找名为 indent 的可执行文件,并执行它。

在 UNIX 或者 Linux 系统中,可执行文件通常存储在 /usr/bin/bin/usr/sbin/sbin/usr/local/bin 等目录中。你可以使用 which 命令来找到 indent 可执行文件的位置,如下:

which indent

这条命令将会显示 indent 可执行文件的完整路径。例如,它可能会显示 /usr/bin/indent,这表示 indent 可执行文件位于 /usr/bin 目录中。

同时,你可以使用 file 命令来查看 indent 文件的详细信息,如下:

file /usr/bin/indent

这条命令将会显示 indent 文件的类型信息,例如它可能会显示 indent: ELF 64-bit LSB executable,这表示 indent 是一个 64 位的 ELF 可执行文件。

* 语法

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参数 含义
–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工具非常适用于使C代码更易于阅读和理解。以下是一些indent命令的使用示例:

  1. 基本使用:
indent myfile.c
  1. 这会将 myfile.c 文件的内容按照默认风格重新格式化,并覆盖原文件。如果你想保留原文件,可以使用 -o 选项输出到新文件:
indent myfile.c -o newfile.c
  1. 使用 GNU 编程风格:
indent -gnu myfile.c
  1. GNU 编程风格是 GNU 项目推荐的代码格式,该命令将源文件按照 GNU 风格重新格式化。
  2. 使用自定义的缩进风格:
indent -i4 -br myfile.c
  1. 在这个例子中,-i4 选项设置了缩进为 4 个空格,而 -br 选项表示将花括号 {} 放在控制语句同一行。
  2. 使用 verbose 模式查看详细信息:
indent -v myfile.c
  1. -v 选项使 indent 输出详细信息,这对于理解 indent 如何更改你的代码可能是有用的。

记住,每次使用indent工具时,最好先对源文件进行备份,以防在格式化过程中出现意外情况。

目录
相关文章
|
2天前
|
监控 Linux Windows
50个必知的Linux命令技巧,你都掌握了吗?(下)
50个必知的Linux命令技巧,你都掌握了吗?(下)
|
3天前
|
Linux Shell Windows
Linux 常用基本命令
Linux 常用基本命令
|
3天前
|
Java Shell Linux
【linux进程控制(三)】进程程序替换--如何自己实现一个bash解释器?
【linux进程控制(三)】进程程序替换--如何自己实现一个bash解释器?
|
4天前
|
Ubuntu Linux Shell
linux免交互登陆远程主机并执行命令(密钥对和Expect)
linux免交互登陆远程主机并执行命令(密钥对和Expect)
|
4天前
|
Linux
【Linux】常用命令
【Linux】常用命令
24 0
|
Linux
原来,在Linux系统也有快速格式化功能
一、问题背景 在使用mkfs格式化1TB左右容量的硬盘时发现所耗费的时间很长,简直是一种折磨。
1585 0
|
6天前
|
机器学习/深度学习 缓存 监控
linux查看CPU、内存、网络、磁盘IO命令
`Linux`系统中,使用`top`命令查看CPU状态,要查看CPU详细信息,可利用`cat /proc/cpuinfo`相关命令。`free`命令用于查看内存使用情况。网络相关命令包括`ifconfig`(查看网卡状态)、`ifdown/ifup`(禁用/启用网卡)、`netstat`(列出网络连接,如`-tuln`组合)以及`nslookup`、`ping`、`telnet`、`traceroute`等。磁盘IO方面,`iostat`(如`-k -p ALL`)显示磁盘IO统计,`iotop`(如`-o -d 1`)则用于查看磁盘IO瓶颈。
|
16天前
|
NoSQL Linux Shell
常用的 Linux 命令
常用的 Linux 命令
36 9
|
4天前
|
安全 Ubuntu Linux
Linux 网络操作命令Telnet
Linux 网络操作命令Telnet
17 0
Linux 网络操作命令Telnet
|
5天前
|
Linux 数据安全/隐私保护
Linux常用命令实例带注释
Linux常用命令实例带注释
30 0