Проверка файлов Visual Studio на наличие комментариев к коду - PullRequest
2 голосов
/ 12 сентября 2009

Я ищу надстройку или макрос для Visual Studio 2008, который будет проверять все файлы .cs и сообщать о «покрытии комментариями кода». Стандарт нашей компании заключается в том, что все классы, методы и свойства C # комментируются кодом. У меня есть большое решение, и просмотр файлов вручную тратит много времени. Если бы у меня был отчет, в котором точно указывалось, какие файлы содержат комментарии к коду, а какие нет, я мог бы проверить только эти файлы.

Я не против написать какой-то код для этого, но я не хочу изобретать велосипед. Есть ли надстройка или макрос, который делает это? В противном случае, есть ли способ использовать отражение или пространство имен System.CodeDom для проверки класса на комментарии кода? Если бы я мог просто загрузить свои классы в объектную модель, я мог бы, вероятно, пройти остаток пути до этого.

Ответы [ 2 ]

5 голосов
/ 12 сентября 2009

Просто включите XML документация в настройках сборки проекта, затем включите "все предупреждения как ошибки". Теперь вы получите ошибки для любых недокументированных классов и членов, которые не являются частными или внутренними.

Расширение Ghost Doc для Visual Studio отлично подходит для сокращения ввода текста и является бесплатным.

Конструктор файлов справки Sandcastle - это самый простой способ направить всю эту документацию в хорошо выглядящие файлы HTML, CHM или HxS.

Еще одна крутая вещь: возможно ссылочный код областей , которые будут включены в качестве примеров в вашу документацию. Переработайте эти юнит-тесты как документацию и убедитесь, что образцы правильные: две птицы с одним камнем! : -)

5 голосов
/ 12 сентября 2009

StyleCop проверяет документацию XML для классов и членов класса.

...