VS2008: автоматически сгенерированные файлы и документация XML

Question

Это раздражение больше, чем проблема. Мой проект содержит несколько автоматически сгенерированных файлов (используя mgmtclassgen.exe). Когда я генерирую документацию XML, моя прекрасно прокомментированная библиотека страдает от предупреждений XML-документации из этих файлов autogen.

Есть ли способ а) подавить создание документации для этих файлов или б) подавить предупреждение CS1591 только для набора файлов? Я, очевидно, не хочу изменять файлы, которые генерируются автоматически, даже если просто добавить прагмы подавления.

Библиотека и сгенерированный код находятся на C #, и я использую Visual Studio 2008.

Answer 1

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

Answer 2

Вы можете отключить определенные предупреждения, используя директиву #pragma, это может соответствовать вашим целям. Синтаксис для отключения предупреждения «отсутствует комментарий XML»:

#pragma warning disable 1591    // Disable 'missing xml comment' warning

Вы можете включить его, используя следующий синтаксис:

#pragma warning restore 1591    // Restore 'missing xml comment' warning

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