CLion教程-从命令行格式化文件

CLion可以根据配置的代码样式设置格式化您的代码。您还可以从命令行应用您的代码样式格式化到指定的文件中。

命令行格式化工具会在后台启动一个CLion实例并应用格式化。如果已经有另一个CLion实例在运行，则此工具将无法工作。在这种情况下，您可以从运行的实例中执行代码样式格式化。使用命令行格式化工具来自动定期维护大型代码库，以确保多个贡献者之间保持一致的编码风格。

要能够格式化文件，请在CLion中安装并启用支持相应文件类型的插件（例如，Shell脚本插件用于格式化Shell脚本文件）。

Windows

您可以在安装目录的bin文件夹中找到用于运行CLion的可执行文件。要将此可执行文件用作命令行启动器，请将其添加到系统的PATH中，如命令行界面中所述。

语法

clion64.exe format [<选项>] <路径 ...>

示例

使用默认代码样式设置格式化C:Datasrc目录中的两个特定文件：

clion64.exe format C:\Data\src\hello.cpp C:\Data\src\world.cpp

递归地使用默认代码样式设置格式化C:Datasrc目录中的所有文件，包括所有子目录：

clion64.exe format -r C:\Data\src

使用来自C:Datasettings.xml的代码样式设置，对C:Datasrc目录中的所有.cpp和.h文件进行非递归格式化：

clion64.exe format -s C:\Data\settings.xml -m *.cpp,*.h C:\Data\src

CLion包含用于运行命令行代码格式化工具的脚本。默认情况下，它位于应用程序包中：CLion.app/Contents/bin/format.sh

语法

, ,
./format.sh [<选项>] <路径 ...>

示例

使用默认代码样式设置格式化~/Data/src目录中的两个特定文件：

, ,
./format.sh ~/Data/src/hello.cpp ~/Data/src/world.cpp

递归地使用默认代码样式设置格式化~/Data/src目录中的所有文件，包括所有子目录：

, ,
./format.sh -r ~/Data/src

使用来自~/Data/settings.xml的代码样式设置，对~/Data/src目录中的所有.cpp和.h文件进行非递归格式化：

format.sh -s ~/Data/settings.xml -m *.cpp,*.h ~/Data/src

您可以在安装目录的bin文件夹中找到用于运行CLion的脚本。要将此脚本用作命令行启动器，请将其添加到系统的PATH中，如命令行界面中所述。

语法

clion.sh format [<选项>] <路径 ...>

示例

使用默认代码样式设置格式化~/Data/src目录中的两个特定文件：

clion.sh format ~/Data/src/hello.cpp ~/Data/src/world.cpp

递归地使用默认代码样式设置格式化~/Data/src目录中的所有文件，包括所有子目录：

clion.sh format -r ~/Data/src

使用来自~/Data/settings.xml的代码样式设置，对~/Data/src目录中的所有.cpp和.h文件进行非递归格式化：

clion.sh format -s ~/Data/settings.xml -m *.cpp,*.h ~/Data/src

选项	描述
`-h`	显示帮助消息并退出。
`-m	-mask`
`-r	-R`
`-s	-settings`
`-allowDefaults`	在没有为文件或一组文件定义代码样式的情况下使用默认代码样式设置：当未设置`s`并且文件不属于任何项目时。否则将忽略文件。
`-charset`	保留编码并强制读取和写入源文件的字符集，例如：`-charset ISO-8859-15`。如果命令行格式化工具无法正确处理源文件中的特殊字符，则此选项很有用。
`-d	-dry`