2012-03-13 3 views
1

Я просто ищу, как получить errors/warning для каждой функции/члена, который не документирован.Force Documentation in VS (2010)

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

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

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

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

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

enter image description here

Edit: Небольшой скриншот, на французском языке, сожалею об этом. Таким образом, некоторые перевод: «Compiler» является вкладку Построить Avertissements = Предупреждение

Благодаря

ответ

2

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

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

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

+0

Итак, мне нужно будет использовать расширение для этого. – squelos

3

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

+2

Да, ну, эта коробка отмечена галочкой. Я думаю, что поведение просто отличается, в зависимости от языка ... Я действительно не могу понять, почему они делают такие вещи ... – squelos