Могу ли я получить отчет об отсутствующей XML-документации

Я пытаюсь использовать GhostDoc, StyleCop, CodeIt.Right, FXCop и т. Д., Чтобы найти упрощенный способ добавления как автоматически сгенерированных XML-комментариев в коде C#, так и обновления существующих комментариев, например, в случае изменения параметров.

GhostDoc Pro, кажется, работает хорошо, за исключением того факта, что я не могу получить отчет об освещении, или, по крайней мере, классы, в которых полностью отсутствует документация.

Как я могу получить такой отчет?

Источник

1 ответ

Решение

Как вы упомянули, GhostDoc поможет вам в этом; Вам просто может понадобиться более новая версия или правильная версия.

Вы можете использовать функцию поддержки документации GhostDoc Pro в версии 5 - она ​​поможет вам найти автоматически сгенерированные документы, найти классы / методы, в которых отсутствует документация, а также те, которые требуют обновления (подпись метода не синхронизирована) или редактирования. Вот больше информации о функциях v5 - http://submain.com/blog/ReleasedGhostDocV50.aspx

Вы упомянули, что вы также используете CodeIt.Right - вы хотите включить правило GE00005 - Внешне видимые типы и члены должны иметь комментарии XML (Тип, Член -> Должны иметь комментарии XML). Вы также можете экспортировать список в VS или создать его в вашей сборке.

И GhostDoc, и CodeIt.Right будут генерировать шаблоны XML-комментариев для отсутствующих документов, но, конечно, вы захотите отредактировать их позже.

Источник
Другие вопросы по тегам