Linux indent 命令 | C / C++ 源代码格式化工具

Linux indent ( indent ) 命令用于格式化 C / C++ 源代码。

indent 命令的定义解释

indent ( indent ) 命令是一个强大的工具，它可以根据一组特定的规则缩进代码，从而帮助您生成格式一致的代码。您将首先了解缩进命令的目的和语法，然后学习如何使用它来格式化 C/ C++ 源代码。最后，您需要自定义缩进格式可以查看选项的解释说明。

安装 indent 命令

在默认情况下，很多系统是没有安装 indent 命令的，要使用 indent 首先要安装 indent：

1、Debian、Ubuntu 安装 indent：

sudo apt update
sudo apt install indent

2、RHEL、AlmaLinux、Rocky Linux 安装 indent：

sudo dnf update
sudo dnf install indent

3、FreeBSD 安装 indent：

sudo pkg update
sudo pkg install indent

4、Arch Linux 安装 indent：

sudo pacman -Sy
sudo pacman -S indent

indent 命令语法

indent [options] [input-files]
indent [options] [single-input-file] [-o output-file]
indent --version

• [options]：可选，可用于自定义代码格式的各种选项
• [input-files]：可选，需要格式化的 C / C++ 多个文件
• [single-input-file]：可选，需要格式化的 C / C++ 单个文件
• [-o output-file]：可选，格式化单个文件时，用于指定输出文件
• 当没有指定格式化文件时，从标准输入读取内容，按 Ctrl + D 结束输入内容

常用格式输出选项

设置大括号位置的选项

• -br, --braces-on-if-line：将大括号放在 if 行上.
• -bl, --braces-after-if-line：在 if 后面加上大括号
• -blf, --braces-after-func-def-line：在函数定义行后面加大括号
• -bls, --braces-after-struct-decl-line：在结构体声明行后面的行加上大括号
• -brf, --braces-on-func-def-line：在函数定义行加上大括号
• -brs, --braces-on-struct-decl-line：在结构体声明行上加大括号

设置缩进的选项

• -blin, --brace-indentn：设置大括号缩进 n 空格
• -cbin, --case-brace-indentationn：在 case 标签后面缩进大括号 n 个空格
• -cin, --continuation-indentationn：连续缩进 n 个空格
• -clin, --case-indentationn： case 标签缩进n个空格
• -dn, --line-comments-indentationn：将代码右侧以外的注释缩进设置为 n 个空格
• -in, --indent-leveln：将缩进级别设置为 n 个空格
• -nut, --no-tabs：使用空格代替制表符
• -tsn, --tab-sizen：设置制表符大小为 n 个空格
• -ut, --use-tabs：使用 tab，这是默认值

设置换行的选项

• -bfda, --break-function-decl-args：声明中所有参数前换行
• -bc, --blank-lines-after-commas：声明中逗号后换行
• -bfde, --break-function-decl-args-end：在声明的最后一个参数之后换行
• -hnl, --honour-newlines：倾向于在输入换行符的位置换行
• -nbc, --no-blank-lines-after-commas：不要强制在声明中的逗号后面加换行符
• -nhnl, --ignore-newlines：不要在输入换行符的位置换行
• -nbap, --no-blank-lines-after-procedures：不要在过程（函数）体之后强制设置空行
• -nbad, --no-blank-lines-after-declarations：不要在声明后强制使用空行
• -ss, --space-special-semicolon：当 for和while 语句为一行时，强制分号前换行

设置函数类型及其名称的选项

• -nbap, --no-blank-lines-after-procedures：不要在过程（函数）体之后强制设置空行
• -npsl, --dont-break-procedure-type：将过程（函数）的类型与其名称放在同一行
• -pcs, --space-after-procedure-calls：在被调用过程（函数）的名称和 ( 之间插入一个空格
• -psl, --procnames-start-lines：将过程（函数）的类型放在其名称之前的行中

indent 命令使用示例

本教程的所有示例都是依据如下的 source1.c 讲解的，文件内容如下：

#include <stdio.h>

int main() {
printf("Hello, World!\n");
return 0;
}

使用默认选项格式化文件

不使用任何参数格式化 source1.c 文件：

indent source1.c

输出文件有些系统为本文件，即：source1.c；有些系统为source1.c.indent，自己查看一下文件即可。

输出内容为：

#include <stdio.h>

int
main ()
{
  printf ("Hello, World!\n");
  return 0;
}

默认情况下函数（过程）的类型与其名称是不在同一行的。

指定输出文件

格式化文件 source1.c 时，指定输出文件为 formatted_source1.c：

indent source1.c -o formatted_source1.c

输出内容与上一个示例相同，只是输出到了指定的 formatted_source1.c 文件中。

将函数的类型与函数名放在同一行

使用选项 -npsl 或长格式形式 --dont-break-procedure-type 将函数的类型与函数名放在同一行

indent -npsl source1.c -o formatted_source1.c

#include <stdio.h>

int main ()
{
  printf ("Hello, World!\n");
  return 0;
}

indent 命令选项解释

如下给出了 Linux indent 命令中所有选项的解释说明：

结语

在本教程中我们介绍了如何使用 indent ( indent ) 命令格式化 C / C++ 源代码。indent ( indent ) 命令是一个强大的工具，它可以根据一组特定的规则缩进代码，从而帮助您生成格式一致的代码。本教程首先介绍了 indent 的基本语法，然后介绍了使用它来格式化 C/ C++ 源代码。最后，给出了所有选项的解释说明。

该 indent 命令可以在 Linux 系统中使用，也可以在 FreeBSD 系统中使用。