Принудительная документация в VS (2010) - PullRequest
1 голос
/ 13 марта 2012

Я просто ищу, как получить errors/warning для каждой функции / члена, которая не документирована.

Я почти уверен, что мне удалось сделать это на одном из моих проектов, но я не могу найти способ сделать это здесь, на моей рабочей станции.

Я посмотрел на project реквизит, решение реквизит, но не могу его найти.

Я, должно быть, что-то пропустил, или, возможно, я мог бы сделать это дома с расширением.

Или это также может быть связано с тем, что я сейчас работаю над проектом VB.Net, а не над проектом C #. Поведение значительно меняется между C# и VB.

И Google не слишком помогает мне ...

enter image description here

Редактировать: небольшой скриншот, на французском, извините за это. Итак, некоторый перевод: «Компилятор» - вкладка «Сборка» Avertissements = Предупреждение

Спасибо

Ответы [ 2 ]

3 голосов
/ 13 марта 2012

Я не могу сказать для VB.NET, но в проектах C # всякий раз, когда вы включаете флажок «Файл XML-документации» в свойствах проекта (вкладка «Сборка»), Visual Studio начинает жаловаться на каждый незарегистрированный открытый элемент и тип.

2 голосов
/ 13 марта 2012

Я не верю, что это возможно для проектов VB.NET.

StyleCop , анализатор кода, который интегрируется с Visual Studio, способен обнаруживать отсутствующую документацию, а также очень много несвязанных вещей. Вам нужно будет настроить параметры самостоятельно, чтобы сохранить только необходимые правила. .Chm проекта содержит все правила; SA1600 - это правило, которое вы ищете, но могут быть и другие удобные.

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

...