Создать пользовательскую документацию (на основе таблицы SQL)
В настоящее время я использую программное обеспечение с собственным интерфейсом командной строки, принимающее собственные команды с параметрами, но эти команды задокументированы в нескольких местах и файлах, поэтому я не могу просто запустить на нем doxygen, и его невозможно добавить документация к этим файлам сейчас.
Создание дампов всего в одном текстовом документе кажется немного раздражающим, поэтому моя первая идея - создать таблицу, например, SQL, и добавить туда документацию с несколькими столбцами, такими как команда и ее описание, аргументы и описание их, пример команды, время выполнения и т. д., и добавьте некоторый графический интерфейс для удобного отображения команд.
Уже есть решения для этого, особенно простые в обслуживании? Или лучше использовать для этого другой подход, такой как HTML-файлы справки?
1 ответ
Вы можете создать его самостоятельно или использовать сторонние инструменты, такие как REDGATE SQLdoc.
ниже приведен один пример того, как генерируется документация для одной таблицы-примера, а также HTML,PDF.
