Генератор документации Visual Studio С++

Есть ли способ получить документацию (например, javadoc) в проекте visual-С++?

Я использую visual studio 2010.

спасибо!

Ответы

Ответ 1

Вы можете использовать формат XML-Documentation, поддерживаемый VS2010. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

После комментирования кода вы можете использовать Sandcastle для создания документации, подобной MSDN: http://sandcastle.codeplex.com/, (Вот представление GUI для Sandcastle, которое намного проще в использовании: https://github.com/EWSoftware/SHFB)

Я использую AtomineerUtils для создания заголовков XML-документации автоматически. Этот инструмент поможет вам. Здесь вы можете иметь бесплатную базовую версию: http://www.atomineerutils.com/products.php

Ответ 2

Вы можете посмотреть Doxygen.

Ответ 3

Вы можете использовать мой addin, Atomineer Pro Documentation, чтобы быстро генерировать комментарии к документации в формате Documentation-XML, Doxygen, Qt или JavaDoc. Затем используйте Sandcastle (DocXml) или Doxygen (DocXml, Doxygen, Qt, Javadoc), чтобы преобразовать эту документацию во внешние файлы документации.

Я бы порекомендовал uing формат DocXml, потому что все вышеперечисленные инструменты работают с ним, и Visual Studio узнает его (он синтаксически раскрашивает его, и он создает документы в своей базе данных intellisense, поэтому он появляется в подсказке подсказки при вводе имя класса/метода в ваш код).

Ответ 4

Один из способов генерации документации - вы уже догадались - javadoc. Вам просто нужно прокомментировать то же, что вы обычно делаете, и javadoc делает хорошую работу по преобразованию их в стиль HTML/LaTeX.

Конечно, это не единственное решение. Я оставлю место для других.

Ответ 6

Если вы используете Visual Studio 2015, то для расширения браузера Macro будет создан генератор Doxygen, который использует JavaScript для этого макроязыка.

Проект находится на github здесь: https://github.com/cppocl/visual_studio_macros