возникла проблема, на которую я не могу найти прямого ответа. Я нахожусь на поздних этапах создания игрового движка с несколькими друзьями, и на данный момент мы стремимся упростить комментарии, чтобы сделать их более удобочитаемыми и полезными для любых разработчиков, которые могут пожелать присоединиться к команде. Поскольку мы используем Visual Studio 2010, встроенные комментарии XML казались идеальным инструментом, и это так! Единственная проблема, с которой мы сталкиваемся, заключается в том, что графическая библиотека, на которой основан наш движок, похоже, имеет ту же идею, а также использует схему комментирования, подобную XML. К сожалению, синтаксис любого инструмента, который они использовали для компиляции своих XML-комментариев, отличается от синтаксиса, используемого в Visual Studio, поэтому, когда Visual Studio пытается отобразить их комментарии в выходном XML-файле проекта, все, что мы получаем, - это огромная строка ошибок, которая действительно связывают процесс и в любом случае совершенно не нужны, поскольку нам нужна только документация для нашего кода. Итак, вкратце, есть ли какой-нибудь параметр компилятора или параметр, который я могу установить в Visual Studio / VC ++, который заставит его генерировать только выходной файл XML-комментариев для наших классов и документации? Большое спасибо.
Заставить Visual C ++ генерировать XML-комментарии только для моих файлов?
comment
Или вы могли удалить их комментарии? Мне любопытно, как VS должен знать, какие файлы ваши.
- person Fosco schedule 27.05.2011
comment
@Fosco - Существующие только в папке проекта или решения? Он генерирует комментарии для файлов заголовков, которые включены в мой проект, поэтому, естественно, компоновщик включает их как часть общей среды времени компиляции, но поскольку они на самом деле не находятся в папке моего проекта и не открываются в текущем решении, он Не кажется ли неправдоподобным, что синтаксический анализатор XML должен уметь различать эти два понятия?
- person DaveStance schedule 27.05.2011
Ответы (1)
Забудьте о Visual Studio и используйте настоящий инструмент для создания документации, например doxygen. Он обрабатывает документацию на основе MS XML, и вы можете настроить его для поиска только в определенных файлах или каталогах.
EDIT Doxygen имеет собственный формат тегов документации, описанный здесь, но он также обрабатывает комментарии в стиле JavaDoc. Комментарии в стиле XML описаны здесь.
person
Dave Rager
schedule
27.05.2011
Ты человек! Спасибо большое, этот инструмент отличный! Я удивлен, что это не привлекло больше внимания, когда я произвел общий поиск автоматизированной документации по C ++.
- person DaveStance; 27.05.2011
Без проблем. Лично я предпочитаю собственные теги разметки Doxygen разметке XML (меньше набора текста, лучшие функции). Я не знаю, есть ли у вас требование использовать разметку XML, но если нет, я бы рекомендовал использовать теги doxygen или даже разметку JavaDoc. С другой стороны, Visual Studio автоматически заглушит разметку XML для вас, и вы все равно сможете добавить разметку в стиле doxygen ...
- person Dave Rager; 27.05.2011
