如何降低 docfx 的冗长程度？

Question

我们使用 docfx，它作为 nuget 包含在我们的一个 csproj 文件中。我没有亲自设置它，也没有关于它如何工作的更多信息，但它看起来像是一个简单的 nuget 添加到 C# 项目，然后在 Visual Studio.[=10 中的项目编译期间生成文档=]

我们的问题是构建日志的详细程度始终设置为详细（或详细或他们如何称呼它），即我在解决方案中有大约 20 个 c# 项目，并且由于我没有警告或错误，构建输出在输出 window 中对于整个解决方案来说非常短，每个项目只有几行。但是这个带有 docfx 的项目在编译期间总是会产生大量输出，因为它将所有详细消息写入输出 window（以及位于项目目录中的 log.txt 文件）。

问题是如何从输出中去掉这个 window。我尝试 google 它，我发现命令行上的 --logLevel 警告参数可以降低冗长程度。但是我们不使用任何命令行，我们在项目中有 nuget。而且我看不到可以指定此 --logLevel 警告的地方。

(使用最新的nuget "docfx.console" version 2.40.4，C#项目是class library类型。我在任何地方都看不到任何特殊设置。Visual Studio msbuild verbosity设置对于输出 window 和日志文件都设置为最小值。）

Answer 1

编辑：自从我第一次回复以来，我发现了一种在项目级别执行此操作的更好方法。

如果编辑 DocFx 项目的 .csproj 文件以包含以下属性组，则可以设置项目的日志级别。

<PropertyGroup>
  <LogLevel>Warning</LogLevel>
</PropertyGroup>

我从这个 git 问题的评论中得到了灵感：https://github.com/dotnet/docfx/issues/2595#issuecomment-379947069

原始回复：

我只找到了一种方法，但是会是全局级别的，升级到新版本可能还要重新设置。

您可以修改docfx.console.targets 文件来更改日志级别。在我的电脑上，它位于

C:\Users\<username>\.nuget\packages\docfx.console\<version number>\build\docfx.console.targets

这是一个 XML 文件，您可以在其中设置要使用的日志级别。

<Project ...>
  <PropertyGroup>
    ...
    <LogLevel Condition=" '$(LogLevel)' == '' ">Verbose</LogLevel>
    ...
  </PropertyGroup>

我将 "Verbose" 更改为 "Warning"，它显着减少了生成的日志消息。

希望对您也有帮助！

如何降低 docfx 的冗长程度？

How to lower docfx verbosity?

c#

msbuild

verbosity

docfx