Документация кода вне файла кода

По некоторым причинам я хочу документировать API, но я не хочу писать документацию непосредственно в исходном коде, как это сейчас широко делается. Я ищу инструмент генератора документации, который мог бы взять в качестве входного файла документации и иметь возможность извлекать прототип функции из исходного кода и проверять соответствие документации. Знаете ли вы какой-нибудь инструмент, который мог бы это сделать?

2

Решение

Doxygen может документировать код также, когда текст документации находится за ее пределами. Просто создайте файл souce, текст которого является комментарием, содержащий заголовки:

Например, если у вас есть

SOURCE.H

void func();

можете добавить

SOURCE.DOX

/**
\function void func()
Your usual doxygen text here.
*/

И сгенерируйте документацию, заставляющую doxygen принимать файлы .h и .dox.

6

Другие решения

Других решений пока нет …