Задать вопрос

Как документировать C++ проект?

Есть рабочий проект на C++, примерно 20к строк. Есть ощущение, что документирование только с помощью Doxygen это недостаточно - структура классов это конечно здорово, но для новичков имхо разбираться в коде будет сложно. Может имеет смысл посмотреть куда-нибудь в сторону UML?
Хочется описать не только отдельную функцию и/или класс, но и какой-то модуль.
  • Вопрос задан
  • 245 просмотров
Подписаться 1 Простой 4 комментария
Ответ пользователя Василий Банников К ответам на вопрос (3)
Может имеет смысл посмотреть куда-нибудь в сторону UML?

UML на практике мёртв. Лучше посмотри в сторону C4 model.
И то максимум до третьего уровня (component diagram). Часто хватает даже второго уровня (container diagram).
Четвёртый уровень (code diagram) слишком сильно детализирован и его слишком тяжело поддерживать в актуальном состоянии.

А лучше ещё сделать пару страничек на внутренней вики с объяснением, что это вообще за проект и что он делает.
Ответ написан
Комментировать