Использование Doxygen для проекта Visual Studio 2008

Я хочу установить и создать документацию Doxygen HTML для одного из проектов в моем решении. Не могли бы вы рассказать процесс пошагово. Я гуглил и нигде не нашел такой информации.

РЕДАКТИРОВАТЬ:
Может ли он быть интегрирован в Visual Studio 2008?

0

Решение

Вы пробовали документацию Doxygen? 🙂
http://www.stack.nl/~dimitri/doxygen/manual.html

То, что я хотел бы сделать, это пройти проект установки и сделать несколько примеров, которые просто обрисовывают в общих чертах методы, которые вы создаете. Начните с малого.

РЕДАКТИРОВАТЬ: Только что увидел ваш пост об использовании с VS 2008. Хотя я не пробовал Doxygen с этой конкретной версией, я подозреваю, что это должно быть возможно, так как вы просто размечаете свои комментарии с тегами, которые распознает Doxygen

3

Другие решения

Я скачал doxygen doxygen-1.8.2-setup.exe из http://www.doxygen.nl/download.html и установил его. Затем запустите его, дайте каталог проекта, для которого мне нужна документация, и некоторые другие параметры. И это все!

1

Сначала вы должны убедиться, что doxygen установлен и доступен по системному пути. Вы также можете установить graphviz (точка) для рисования графика.

Далее запустите:

doxygen -g MyProject.doxyconf

Это создает файл конфигурации doxygen. Отредактируйте этот файл, чтобы настроить его. Он содержит комментарии, описывающие, что делают опции, поэтому установите их соответственно.

Теперь вы можете сгенерировать документацию Doxygen, используя:

doxygen MyProject.doxyconf

Чтобы интегрировать это с Visual Studio, создайте новый проект make-файла (например, MyProject.documentation). Затем это можно настроить для запуска следующих команд:

Build   : doxygen MyProject.doxyconf
ReBuild : doxygen MyProject.doxyconf
Clean   : cd $(ProjectDir)/docs && del /s *.*

ПРИМЕЧАНИЕ: я не уверен, если $(ProjectDir) правильно, но вам все равно нужно изменить $(ProjectDir)/docs в место, где создается документация.

Затем вы можете добавить документацию к проекту по мере необходимости. Мой совет по этому вопросу — делать это итеративно. Начните с одной области (заголовок / класс) и посмотрите, что выводит кислород, а затем постепенно улучшайте его.

http://www.stack.nl/~dimitri/doxygen/docblocks.html показывает основы добавления документации по доксигену.

http://www.stack.nl/~dimitri/doxygen/commands.html предоставляет ссылку на все доступные команды, используемые в комментариях docygen.

http://www.stack.nl/~dimitri/doxygen/manual.html предоставляет дополнительную документацию.

0
По вопросам рекламы ammmcru@yandex.ru
Adblock
detector