Включить предупреждение компилятора C ++ за отсутствующую документацию XML - PullRequest
2 голосов
/ 28 февраля 2011

Когда документация XML включена для моих проектов C ++ (управляемых), компилятор не выдает никаких предупреждений о пропущенных комментариях.

Я включил генерацию документации, установив для параметра «Генерировать файлы документации XML» (/ doc) значение true, как описано здесь . Проект настроен как динамическая библиотека с / clr и уровнем предупреждения 4 (/W4).

Для проектов C # компилятор выдает Отсутствующий комментарий XML для публично видимого типа или члена 'Type_or_Member' , когда комментарии отсутствуют. Чтобы заставить разработчиков делать соответствующие комментарии, я хотел бы иметь такое же поведение для проектов C ++. Как мне получить это?

1 Ответ

2 голосов
/ 07 марта 2011

XML-комментарии VC ++ не обрабатываются, скажем, как .NET.Компилятор VC ++ обрабатывает комментарии и генерирует файлы .xdc, которые впоследствии собираются инструментом xdcmake.exe в файлы xml.Однако нет возможности указать компилятору выдавать предупреждения, если отсутствуют XML-комментарии, известные как .NET.

(см. http://msdn.microsoft.com/en-us/library/ms177227.aspx и http://msdn.microsoft.com/en-us/library/ms177247.aspx)

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