Doxygen помогает создавать документацию из комментариев, но кто поможет написать комментарии?

This post is also available in: Английский

Не исчерпывающий, но довольно развернутый ответ на этот вопрос дает страница «средства» проекта doxygen. Из всего, что там представлено слюновыделение вызывает только один проект. Называется он Atomineer. Все, что он умеет описано на странице проекта. Расскажу коротко: программист пишет код — плагин пишет комментарии для Doxygen. Очень удобно для рутинных действия, таких, как описание параметров функций или возвращаемых значений. Разработчики так же уверяют, что автосгенерированные комментарии будут обновляться вместе с обновлением кода. Так же, если писать код в стиле «самодокументирования», то вручную документировать практически ничего не прийдется.

Хорошо ли это работает? Еще не пробовал, но обязательно попробую. Стоит плагин $10, и если он решит проблему с документированием, то это не много.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *