Каков наилучший инструмент или метод написания комментариев для кода кислорода?

Question

Публичные заголовочные файлы c ++ должны быть снабжены множеством комментариев. Трудно отформатировать и обернуть комментарии doxygen. Существует ли какой-либо инструмент форматирования?

С такими функциями, как автоматическое наложение строк на 80-й символ, легкое визуальное группирование функций. В идеале автор документации готовит документацию отдельно, а затем внедряет ее или связывает с помощью докси-тегов с кодом.

В настоящее время мы используем блокнот / IDE для документирования кода.

Answer 1

Вы не говорите, с какой IDE вы работаете - если вы работаете в Visual Studio, то я написал надстройку ( AtomineerUtils ), которая может вам помочь - она ​​генерирует / обновляет Комментарии к документации XML, Doxygen или JavaDoc в ваших исходных файлах, а также могут переносить слова и форматировать комментарии для вас, сводя к минимуму работу, которую необходимо выполнить, чтобы сохранить их аккуратными. Он также синхронизирует комментарии с кодом (параметры, параметры типа, выданные исключения и т. Д.).

(Поддерживает C, C ++, C ++ / CLI, C #, Visual Basic и Java, в Visual Studio 2010, 2008, 2005).

Answer 2

Emacs + doxymacs отлично работает для меня.