Заставить Visual C ++ генерировать комментарии XML исключительно для моих файлов? - PullRequest
1 голос
/ 27 мая 2011

возникла проблема, на которую я не могу найти прямой ответ. Я нахожусь на поздних стадиях создания игрового движка с несколькими друзьями, и на данный момент мы стремимся упростить комментарии, чтобы сделать их более читабельными и полезными для любых разработчиков, которые могут захотеть присоединиться к команде. Поскольку мы используем Visual Studio 2010, встроенные комментарии XML кажутся идеальным инструментом, и это так! Единственная проблема, с которой мы сталкиваемся, заключается в том, что графическая библиотека, на которой основан наш движок, похоже, имеет ту же идею, а также использует XML-подобную схему комментирования. К сожалению, синтаксис любого инструмента, который они использовали для компиляции своих комментариев XML, отличается от синтаксиса, используемого в Visual Studio, поэтому, когда Visual Studio пытается отобразить свои комментарии в выходной файл XML проектов, все, что мы получаем, - это огромная строка ошибок, которые действительно свяжите процесс и в любом случае совершенно не нужны, так как нам нужна только документация для нашего кода. Итак, вкратце, есть ли какой-нибудь параметр или параметр компилятора, который я могу установить в Visual Studio / VC ++, который заставит его генерировать только выходной файл XML-комментариев для наших классов и документации? Огромное спасибо.

1 Ответ

2 голосов
/ 27 мая 2011

Забудьте о Visual Studio и используйте инструмент для создания реальной документации, такой как doxygen .Он обрабатывает документацию на основе MS XML, и вы можете настроить его для поиска только определенных файлов или каталогов.


РЕДАКТИРОВАНИЕ У Doxygen есть собственный формат тегов документации , описанный здесь но он также обрабатывает комментарии в стиле JavaDoc.Комментарии в стиле XML описаны здесь .

...