Интеграция Doxygen с (неуправляемой) Visual C++ 2005
Мы медленно продвигаемся к более стандартизированным комментариям в большом проекте C++, представляя Doxygen. Лично я нахожу боль в наборе комментариев, тем более что Java IDE настолько хороши в автоматизации этого процесса.
Вот я и подумал, какие там могут быть инструменты? Поиском оказался DoxyComment, который выглядит довольно неплохо, это лучший / стандартный инструмент или есть и другие, которые тоже стоит посмотреть?
2 ответа
Если ввод мета-комментариев, являющихся инструкциями для doxygen, является важной частью ваших усилий по написанию комментариев, вы делаете это неправильно.
Комментарий не должен включать в себя вещи, которые могут быть автоматически определены инструментом, любой программист будет определять столько же (или больше) информации, например, из имен параметров, чем любой инструмент.
Другой способ взглянуть на это состоит в том, что doxygen уже делает отличную работу, представляя то, что может быть определено автоматически. Вам не нужно писать: "B::B создает объект B", поскольку doxygen автоматически отсортирует его в разделе конструкторов документации.
Сосредоточьтесь на том, что не очевидно, и найдите время, чтобы подумать о том, что вы пишете.
Обычно многим функциям и переменным не требуется отдельный комментарий, так как либо имя достаточно описательное, либо их лучше объяснить в комментариях на уровне класса, описывающих взаимодействие нескольких членов.
Atomineer - это инструмент, который я и некоторые другие использовали для документирования неуправляемого кода C++ с помощью разметки Doxygen. Это не бесплатно, но это дешево и, возможно, стоит попробовать: http://www.atomineerutils.com/products.php