Visual Studio: предупреждение об отсутствии XML-документации для частных и внутренних участников

Я использую Visual Studio 2005 (VS.8.0), и я хочу обеспечить соблюдение требования о том, чтобы все члены класса, а не только общедоступные, были задокументированы. Хотя настроить Visual Studio для генерации предупреждений, когда общедоступные, защищенные или внутренние защищенные члены не задокументированы, тривиально, я ищу способ, чтобы частные и внутренние члены выдавали такое же предупреждение. Какие-либо предложения?

ПРИМЕЧАНИЕ. Я использую уровень предупреждений 4, обрабатываю предупреждения как ошибки, и у меня установлен флаг «Создать XML».


visual-studio compiler-warnings xml-documentation
person David Beckman    schedule 23.07.2009    source источник
comment
Вы когда-нибудь догадывались об этом? Мне был бы интересен ответ.   -  person SqlRyan    schedule 14.10.2009
comment
@rwmnau - Нет, еще нет. Я предполагаю, что это невозможно сделать с помощью автоматических проверок, поэтому я делал это вручную. Такова жизнь...   -  person David Beckman    schedule 15.10.2009

Ответы (1)


arrow_upward
3
arrow_downward

К сожалению, Visual Studio 2005 не предоставляет способа принудительно применять XML-документацию к закрытым или внутренним членам и типам.

Я бы порекомендовал попробовать StyleCop, но он не поддерживает Visual Studio 2005 (на самом деле последняя версия, к сожалению, больше даже не поддерживает Visual Studio 2008). Однако можно настроить StyleCop, чтобы обеспечить соблюдение документации для всех участников.

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

person Jeff Yates    schedule 03.11.2010