Javadoc-подобная документация для С++

Существуют ли подобные системы генерации документации, такие как Javadoc, для С++? Javadoc производит хороший результат; Было бы здорово, если бы вы могли использовать что-то подобное на других языках.

Ответы

Ответ 1

Есть несколько инструментов, которые работают как JavaDoc для C++. Наиболее популярным инструментом, вероятно, является doxygen. Он может обрабатывать JavaDoc-подобные комментарии, а также несколько языков (например, C++, C, Java, Objective-C, Python, PHP, С#). Он имеет довольно хорошую поддержку для настройки стиля вывода HTML с использованием CSS (см. Список пользователей для примера документации).

При выборе системы документирования необходимо решить две важные проблемы:

  • Документируйте сущности, которые вас интересуют. Хотите ли вы документировать систему в соответствии со структурой кода или в соответствии с некоторыми другими подразделениями модуля?
  • Получение вывода в формате, как вы хотите. Это предпочтительно, когда документация соответствует вашему общему стилю проекта.

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

Ответ 2

Вы не можете использовать javadoc специально, но есть несколько инструментов, которые делают то, что вы хотите. Большинство людей, как правило, используют Doxygen. Вот несколько ссылок для Doxygen и DoС++:

Doxygen
DoС++

Ответ 5

Я только начинаю использовать Sphinx для своих проектов Python. На его домашней странице указано, что "C/C++ уже поддерживается".

Он использует легкую разметку под названием " reStructuredText ".

Я только начал использовать его для своих проектов на Python, и мне очень понравился его внешний вид.