0

我目前正在使用具有自己命令行界面的软件,接受带有参数的自己的命令,但是这些命令记录在多个位置和文件中,因此我不能简单地在其上运行 doxygen,并且无法添加现在这些文件的文档。

将所有内容转储到一个文本文档中似乎有点烦人,所以我的第一个想法是生成一个表,例如 SQL,并在那里添加文档,其中包含几列,例如命令及其描述、参数和它们的描述,示例命令、执行时间等,并添加某种 GUI 以轻松显示命令。

是否已经有解决方案,尤其是易于维护的解决方案?还是为此采用不同的方法更好,例如基于 html 的帮助文件?

4

1 回答 1

0

您可以自己构建一个或使用一些第三方工具,如REDGATE SQLdoc ..

下面是如何为一个示例表生成文档的一个示例,如 HTML、PDF

在此处输入图像描述

于 2017-11-14T13:48:45.490 回答