Фон
Я работаю над небольшим проектом кодирования, который будет продаваться другим компаниям. Мне нужно было создать для него документацию, поэтому я решил использовать Sandcastle. После долгой загрузки и установки я, наконец, получил его работу и заметил, что какой-либо публичный метод или класс, у которого не было комментариев, имел красный текст, в котором говорилось, что комментарий отсутствует. Затем я установил Ghostdoc, чтобы ускорить мой комментарий. Это включало предупреждения компилятора о отсутствующих комментариях xml, что было здорово, потому что теперь у меня был список всего, что мне нужно было прокомментировать.
Проблема
Один из моих файлов кода - это автоматически сгенерированный файл, содержащий около 3000 предупреждений компилятора. Мне нужно пропустить этот файл из создания предупреждений компилятора "Missing Xml Comment". Я знаю эти вещи из этого сообщения:
- Я знаю, что могу отключить предупреждение компилятора для проекта, но есть другие файлы в проекте, которые должны иметь предупреждение о компиляторе.
- Я знаю, что могу использовать
#pragma warning disable 1591
, чтобы удалить предупреждение компилятора, но файл автогенерируется, и я действительно не хочу, чтобы его повторно добавлять вручную каждый раз. - Я знаю, что могу добавить пустой комментарий, но еще раз, я действительно не хочу повторно добавлять его каждый раз, когда файл восстанавливается.
- Я мог бы вытащить файл в свой собственный проект, поскольку он является единственным классом в нем, а затем удаляет требование комментариев XML, но я не хочу, чтобы клиент имел дело с другой dll.
- Классы - это частичные классы, поэтому я думал о том, чтобы попытаться найти способ отключения предупреждения #pragma в частичном классе, но даже если это было возможно, все еще есть перечисления, которые выдавали бы предупреждения.
Как я могу заставить VS игнорировать один файл для определенного типа предупреждения?