2009-06-17 5 views
6

У меня есть набор 250 файлов заголовков и файлов cpp моего проекта. Я хотел отформатировать старый код и создать документацию по API. Есть ли какой-нибудь инструмент, который может мне помочь?Исходный код для C++ (vC++)?

Я думаю об использовании DOxygen, но я считаю, что ему нужна информация в каком-то формате.

ответ

10

Использовать Doxygen для строительной документации. Он может много сделать из источника как есть с правильными настройками. Он становится лучше с подходящими комментариями для каждого документального объекта. Однако Doxygen не поможет вам упорядочить формат и формат вашего кода.

Для решения этой задачи вы хотите использовать кодовый декодер. Классическим инструментом был indent. Тем не менее, гораздо более универсальный инструмент - Uncrustify, который является одним из нескольких украшений, включенных в четко обозначенный Universal Indent GUI. Последний инструмент поддерживает широкий спектр языков и предоставляет удобный интерфейс графического интерфейса, который поможет вам настроить настройки на ваш предпочтительный стиль.

Все вышесказанное является бесплатным и открытым исходным кодом, кстати.

После того, как вы воспользуетесь Doxygen, вы также захотите установить инструменты Graphviz, чтобы он мог рисовать диаграммы вызовов и другие диаграммы.

+0

Это большие ссылки :) – toto

+0

Там, это намного лучше. – RBerteig

6

У меня был хороший опыт работы с astyle (Artistic Style); он прост в использовании и настройке.

+0

Astyle: просто перетащите исходный файл на значок, и вы получите готовый источник. – siddhant3s

Смежные вопросы