Как игнорировать класс при создании XML-документации для проекта Visual Studio?

У меня есть проект Visual Studio (C #), в котором включено свойство «XML-файл документации». Также для параметра «Обрабатывать предупреждения как ошибки» установлено значение «Все».

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

Есть ли способ игнорировать этот конкретный класс, когда дело касается документации XML?


person brett rogers    schedule 31.07.2009    source источник


Ответы (1)


В файле класса поместите прагму вверху файла, чтобы отключить данный номер предупреждения.

#pragma warning disable (warning #)

Номер ошибки для предупреждений XML-документации - 1591, поэтому он выглядит так:

#pragma warning disable 1591
person womp    schedule 31.07.2009
comment
Похоже, что предупреждение # 1591, но отключение предупреждения #pragma помогло. Спасибо. - person brett rogers; 31.07.2009
comment
Если вы хотите сделать это с несколькими файлами (в моем случае с тысячами), вы можете применить предупреждения не как элемент ошибок: stackoverflow.com/questions/267168/ - person Rob Fonseca-Ensor; 18.01.2010