CLion教程-从命令行运行代码检查

CLion通过运行代码检查来查找并突出显示语法错误、死代码、可能的错误、糟糕的编码风格以及其他问题。您还可以从命令行运行为特定项目配置的所有检查，并将结果保存为XML、JSON或纯文本文件以进行报告。

命令行检查器会在后台启动一个CLion实例，然后在其中运行检查。如果已经有另一个CLion实例在运行，则此工具将无法工作。在这种情况下，您可以在运行的实例中使用检查。使用命令行检查器自动定期对具有许多贡献者的大型项目进行代码分析。

Windows

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

语法

clion64.exe inspect <项目> <检查配置文件> <输出> [<选项>]

示例

使用最大详细程度，检查C:MyProjectsrc目录中C:MyProject项目的代码，并将结果保存为位于C:MyProjectInspectionResults下的XML文件，使用C:MyProject.ideainspectionProfilesMyProfile.xml配置文件：

clion64.exe inspect C:\MyProject C:\MyProject\.idea\inspectionProfiles\MyProfile.xml C:\MyProject\InspectionResults -v2 -d C:\MyProject\src

macOS

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

语法

, ,
inspect.sh <项目> <检查配置文件> <输出> [<选项>]

示例

使用最大详细程度，检查~/MyProject/src目录中~/MyProject项目的代码，并将结果保存为位于~/MyProject/InspectionResults下的XML文件，使用~/MyProject/.idea/inspectionProfiles/MyProfile.xml配置文件：

, ,
inspect.sh ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

Linux

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

语法

clion.sh inspect <项目> <检查配置文件> <输出> [<选项>]

示例

clion.sh inspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

选项

选项	描述
`-changes`	仅在本地未提交的更改上运行检查。
`-d`	如果您不想检查整个项目，可以指定子目录的完整路径。
`-format`	指定输出文件的检查结果格式：`xml`（默认值）、`json`或`plain`。
`-v`	设置输出的详细程度：`-v0`是默认的低详细程度，`-v1`是中等详细程度，`-v2`是最大详细程度。

检查配置文件

一个检查配置文件是一个.xml文件，用于指定启用的检查及其选项。

默认情况下，项目的检查配置文件存储在项目目录下：.idea/inspectionProfiles。

全局IDE检查配置文件存储在IDE配置目录下的inspection文件夹中。

检查结果

您可以在CLion或任何文本编辑器中打开生成的检查结果XML文件，就像打开常规文件一样。然而，使用问题工具窗口的离线视图来分析更方便：

查看检查结果

打开您运行检查的项目。
从主菜单选择“代码” | “分析代码” | “查看离线检查结果”。
选择包含检查结果的目录，然后点击“确定”。