InspectCode 命令行工具

--项目 — 允许分析特定项目，而不是整个解决方案。 在此参数之后，您可以输入项目名称或与解决方案中多个项目匹配的通配符。 例如， --project=*Billing。

--include/--exclude — 定义在检查报告中包含/排除哪些文件的文件掩码。 如果 --包含 和 --排除 都已定义并覆盖相同的文件集，则 --排除 将具有更高优先级。

您可以在文件掩码中使用 Ant 风格通配符：

• ? 匹配单个字符（不包括目录分隔符）

• * 匹配零个或多个字符（不包括目录分隔符）

• ** 匹配任意数量的字符（包括目录分隔符）

• / 或 \ 匹配目录分隔符，无论操作系统路径格式如何

例如，模式 **Test?\**.* 将匹配以下文件：

• C:\Projects\MyTestX\data\file_one.txt

• /home/projects/TestY/file_two.xml

但不包括：

• C:\Projects\Test\data\file_one.txt

• /home/projects/TestY/file_two

要指定多个路径或通配符，请用分号 ; 分隔它们，或多次使用 --include/--exclude 参数。

--swea 和 --no-swea — 这些参数允许您显式启用或禁用 解决方案范围分析。 否则，解决方案范围的分析将根据现有设置启用或禁用。

--severity (-e) — 默认情况下，InspectCode 仅报告 建议及更高严重级别的问题。 此参数允许您将最小报告的严重级别更改为 [INFO, HINT, SUGGESTION, WARNING, ERROR]。 例如， -e=WARNING。

--dumpIssuesTypes-it — 使用此选项将所有现有的 代码检查转储到 输出中。 此选项应单独使用，而不是与实际分析一起使用，即不带解决方案参数。

--build/--no-build — 允许您指定是否 在开始分析之前构建目标解决方案。 默认情况下，InspectCode 始终构建解决方案。

--目标 — 允许您指定在开始分析之前要执行的 MSBuild 目标。 您可以指定任何目标，但必须在目标解决方案的所有 .csproj 文件中定义。 默认情况下，执行 构建 目标。

如果未构建解决方案，即指定了 --no-build 参数，则 --目标 参数将不起作用。

--属性 — 允许您覆盖 MSBuild 属性。 您可以单独设置每个属性（--properties:prop1=val1--properties:prop2=val2 ），或使用分号分隔多个属性 --properties:prop1=val1;prop2=val2。

请注意，分号不能用于值内部，例如： --properties:ReferencePath="r:\reference1\;r:\reference2\"。 在这种情况下，请使用另一个 --属性 参数分别添加每个值——这些值将被组合。

指定的属性将应用于所有被分析的项目。 目前，没有直接的方法仅将属性设置为特定项目。 解决方法是在此项目中创建一个自定义属性，并将其分配给所需的属性，然后在 InspectCode 参数中使用该自定义属性。

--工具集——使用此选项指定确切的 MSBuild 版本。 例如 12.0： --toolset=12.0 默认情况下，使用可用的最高 MSBuild 版本。 如果您有多个相同版本的安装，例如来自 Visual Studio 2019 的 16.0 和来自 .NET Core 3.x 的 16.0，此选项可能不起作用。

--toolset-path——使用此选项指定 MSBuild 的确切路径。 如果您有自定义的 MSBuild 安装并希望将其与 InspectCode 一起使用，这可能会有所帮助，例如： --toolset-path="c:\tools\msbuild\bin\MsBuild.exe"。

--dotnetcore——默认情况下，.NET 安装是自动检测的。 如果自动检测导致冲突，您可以使用此选项指向特定的 .NET 安装。 使用时不带参数以忽略 .NET Core。 示例： --dotnetcore=/usr/local/share/dotnet/dotnet。

--dotnetcoresdk——使用此选项指定应提供 MSBuild 的 .NET SDK 版本。 例如，如果您安装了带有 SDK 5.0.100 和 6.0.302 的 .NET，InspectCode 将优先选择 6.0.302（最新版本，包括预览版本）。 现在，如果您想使用 .NET SDK 5.0.100 运行 InspectCode，请在命令行中添加 --dotnetcoresdk=5.0.100。

--mono — 默认情况下，Mono 安装是自动检测的。 您可以使用此选项指向特定的 Mono 安装，如果自动检测导致冲突。 使用时不带参数以忽略 Mono。 示例： --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono。

--targets-for-references——自定义 MSBuild 目标的名称，这些目标将被执行以获取项目的引用程序集。 这些目标定义在项目文件或 .目标 文件中。 多个值用分号分隔。 例如， --targets-for-references="GetReferences"。

--targets-for-items——自定义 MSBuild 目标的名称，这些目标将被执行以获取项目的其他项（例如，Compile 项）。 这些目标定义在项目文件或 .目标 文件中。 多个值用分号分隔。 例如， --targets-for-items="GetCompileItems"。

--输出-o — 允许您设置输出文件。

--format (-f) — 默认情况下，InspectCode 将其输出写入 SARIF 格式。 如果需要，您可以使用此参数 [Html, Text, Xml] 指定其他输出格式。 例如， -f=Text。

要在一次运行中生成多个输出工件，请指定用分号分隔的所需格式，例如： --format=Html;Xml ；或多次添加此参数，例如 --format=Html --format=Xml。 在生成多个工件时，您可以在 --输出 参数中指定一个目录，文件名将自动生成；或者您可以指定一个文件名，不同的文件扩展名将用于不同的工件。

--jobs (-j) — 默认情况下，InspectCode 使用启发式方法拆分其任务，并使用尽可能多的线程/核心并行运行。 如果需要，您可以限制线程数量，例如， -j=4。

--absolute-paths (-a) — 默认情况下，InspectCode 报告中的文件路径是相对于解决方案文件的。 您可以使用此开关在报告中使用绝对路径。

--debug (-d) — 使用此选项将 InspectCode 的执行详细信息添加到输出中。 如果您在使用 InspectCode 时遇到问题，这些详细信息在联系 支持团队时会很有帮助。

--详细程度 — 默认情况下，InspectCode 仅在输出中显示错误消息。 使用此参数更改写入输出的信息量，按以下级别（从少到多详细）： [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE]。

--LogLevel——使用此参数控制写入日志文件的信息量，通过 --LogFile 或 --LogFolder 指定。 以下是级别（从少到多）： [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE]。

例如，如果 InspectCode 出现问题，您可以联系 JetBrains Rider 支持并共享包含所有 TRACE 消息的日志文件： --LogLevel=TRACE。

--LogFile — 使用此参数为 InspectCode 的消息指定日志文件的绝对路径。 如果您还需要 MSBuild 和 Roslyn 的日志，请改用 --LogFolder 参数。

--LogFolder — 使用此参数指定一个绝对路径到目录，其中应写入 InspectCode 的日志以及 MSBuild 和 Roslyn 的日志。 如果您只需要 InspectCode 的日志，请改用 --LogFile 参数。

--caches-home — 允许您为 InspectCode 缓存的数据指定自定义位置。 默认情况下，使用 %LOCALAPPDATA% 目录，除非有设置文件，在这种情况下使用其中指定的目录。 如果您希望为缓存使用快速 SSD 磁盘，或者希望将所有构建处理数据存储在一个地方，此参数可能会有所帮助。

--config-create 和 --配置 — 这些选项允许您通过配置文件传递上述参数。 第一个选项将根据当前参数创建一个配置文件；第二个选项用于从该文件加载参数。

--eXtensions (-x) — 安装并启用指定的插件。

插件通过其 ID 指定，您可以在 JetBrains Marketplace的插件页面上找到：找到所需插件并滚动到 概览 选项卡的底部。

例如， StyleCop by JetBrains 插件的插件 ID 是 StyleCop.StyleCop ，要使用此插件运行 InspectCode，您需要在命令行中添加 -x=StyleCop.StyleCop。

要指定多个插件，请用分号分隔它们的 ID。

--源——允许您指定自定义的插件安装源，即包含插件 .nupkg 文件的目录，例如 --source="C:\plugins"。 如果未指定任何内容，InspectCode 将在 JetBrains Marketplace中查找插件。

--测量——一个诊断选项，如果您在特定硬件上运行工具时遇到性能问题，可以帮助您。 使用此选项时，需通过以下参数之一 [sampling | timeline (Windows-only) | memory] 定义分析类型，例如：

执行完成后，除了问题报告文件外，InspectCode 还会创建一个执行快照并显示快照文件的路径。 您可以使用 JetBrains 工具研究快照：

• 采样或 时间线分析：要分析生成的 .zip 文件，请解压并使用 JetBrains dotTrace打开采样快照文件（ .dtp ）或时间线快照文件（ .dtt ）。

• 内存分析：要分析生成的 dotMemory 工作区文件（ .dmw ），请使用 JetBrains dotMemory打开它。

--version (-v) — 使用此选项显示工具的当前版本并退出。

--no-updates — 默认情况下，InspectCode 在每次运行时检查更新。 使用此选项可禁用更新检查。

--设置 — 默认情况下，InspectCode 将使用 “解决方案团队共享”层 SolutionName.DotSettings 中的 ReSharper 设置覆盖其默认设置（如果存在）。 如果需要，您可以使用此参数指定另一个 .DotSettings 文件，该文件将覆盖所有其他设置。 例如，

.

--disable-settings-layers (-dsl)——禁用指定的 设置层。 接受的值： GlobalAll、 GlobalPerProduct、 SolutionShared、 SolutionPersonal

--no-buildin-settings——抑制全局、解决方案和项目设置层的设置。 等同于 --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal。