Как понизить многословность docfx? - PullRequest
0 голосов
/ 04 декабря 2018

Мы используем docfx, он включен как nuget в один из наших файлов csproj.Лично я не настраивал эту вещь, и у меня нет больше информации о том, как она работает, но похоже, что это простой добавленный к проекту C # nuget, который затем создает документацию во время компиляции проекта в Visual Studio.

Наша проблема в том, что многословность журнала сборки всегда установлена ​​на подробный (или подробный, или как они его называют), то есть у меня как 20 проектов c # в решении, и так как у меня нет предупреждений или ошибок, вывод сборки в окне «Вывод»очень коротко для всего решения, всего несколько строк на проект.Но этот один проект с docfx всегда производит МНОГО выходных данных во время компиляции, потому что он записывает все подробные сообщения в окно вывода (а также в свой файл log.txt, расположенный в каталоге проекта).

Вопрос в том, какизбавиться от этого из окна вывода.Я попытался найти его в Google, и обнаружил, что параметр --logLevel в командной строке может снизить детализацию.Но мы не используем никакой командной строки, у нас есть nuget в проекте.И я не вижу места, где можно было бы указать это предупреждение --logLevel.

(Используя последнюю версию nuget "docfx.console" версии 2.40.4, проект C # имеет библиотеку классов типов. Я не вижу никакойспециальные настройки в любом месте. Настройка Visual Studio для многословности msbuild установлена ​​на минимальное значение как для окна вывода, так и для файла журнала.)

1 Ответ

0 голосов
/ 22 февраля 2019

РЕДАКТИРОВАТЬ: Со времени моего первого ответа я нашел лучший способ сделать это на уровне проекта.

Если вы отредактируете файл .csproj для проекта DocFx, включив в негоВ следующей группе свойств вы можете установить уровень журнала для проекта.

<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>

Я изменил "Подробно" на "Предупреждение ", и это значительно уменьшило количество создаваемых сообщений журнала.

Надеюсь, это вам тоже поможет!

...