Принудительно xml-комментарий для всех участников - PullRequest
4 голосов
/ 23 марта 2009

Для открытых участников я получаю предупреждение «отсутствует XML-комментарий для публично видимого типа или члена ...». Это здорово, но недостаточно. Я хотел бы включить это предупреждение для всех (или хотя бы внутренних и защищенных) членов.

Есть ли способ получить предупреждение или информацию о недостающих комментариях xml? Существуют ли какие-либо инструменты во время выполнения (например, Resharper) с этой функцией?

Ответы [ 3 ]

4 голосов
/ 23 марта 2009

Если вы используете ReSharper, используйте плагин Agent Smith для ReSharper. Это открытый исходный код, так что не стесняйтесь посмотреть, какая у них там слизь.

Агент Смит HomePage

Исходный код агента Смита в Google Code

РЕДАКТИРОВАТЬ: Агент Смит выполняет проверку XML-комментариев во время выполнения редактора кода (из-за отсутствия лучшего слова)

3 голосов
/ 23 марта 2009

StyleCop (он же MS SourceAnalysis) может сделать это за вас. Вот блог команды , где вы можете узнать больше об этом.

1 голос
/ 23 марта 2009

Выезд StyleCop . Это инструмент Microsoft, который может быть интегрирован в вашу сборку и генерировать предупреждения или ошибки, если его правила стиля не соблюдаются.

У него есть правило: "SA1600: ElementsMustBeDocumented", которое может соответствовать вашим требованиям.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...