生成自定义文档(基于SQL表)

时间:2017-11-14 13:38:52

标签: sql documentation help-files

我目前正在使用一个带有自己命令行界面的软件,接受带有参数的命令,但这些命令记录在几个地方和文件中,所以我不能简单地在它上面运行doxygen,而不是现在可以为这些文件添加文档。

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

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

1 个答案:

答案 0 :(得分:0)

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

下面是如何为HTML,PDF以及

为一个样本表生成文档的一个示例

enter image description here