生成自定义文档(基于SQLtable)
Generate custom documentation (based on SQL table)
我目前使用的软件有自己的命令行界面,接受带参数的命令,但这些命令记录在几个地方和文件中,所以我不能简单地 运行 doxygen在上面,现在无法向这些文件添加文档。
将所有内容都转储到一个文本文档中使用起来似乎有点烦人,所以我的第一个想法是生成一个 table、SQL,例如,并在其中添加文档,其中包含多个列,例如命令及其描述、参数及其描述、示例命令、执行时间等,并添加某种 GUI 以轻松显示命令。
是否已经有解决方案,特别是易于维护的?
还是对此采用不同的方法更好,例如基于 html 的帮助文件?
您可以自己构建一个或使用一些第三方工具,例如 REDGATE SQLdoc..
下面是一个示例,说明如何为一个样本 table 生成文档 HTML,还有 PDF
我目前使用的软件有自己的命令行界面,接受带参数的命令,但这些命令记录在几个地方和文件中,所以我不能简单地 运行 doxygen在上面,现在无法向这些文件添加文档。
将所有内容都转储到一个文本文档中使用起来似乎有点烦人,所以我的第一个想法是生成一个 table、SQL,例如,并在其中添加文档,其中包含多个列,例如命令及其描述、参数及其描述、示例命令、执行时间等,并添加某种 GUI 以轻松显示命令。
是否已经有解决方案,特别是易于维护的? 还是对此采用不同的方法更好,例如基于 html 的帮助文件?
您可以自己构建一个或使用一些第三方工具,例如 REDGATE SQLdoc..
下面是一个示例,说明如何为一个样本 table 生成文档 HTML,还有 PDF