我目前使用的软件有自己的命令行界面,接受自己的带参数的命令,但这些命令记录在几个地方和文件中,所以我不能简单地在它上面运行 doxygen,也不能添加这些文件的文档。
将所有内容转储到一个文本文档中似乎有点烦人,所以我的第一个想法是生成一个表,例如 SQL,然后在那里添加文档,其中包含几列,例如命令及其描述、参数和它们的描述,示例命令、执行时间等,并添加某种 GUI 以轻松显示命令。
是否已经有解决方案,特别是易于维护的解决方案?或者最好为此采用不同的方法,例如基于 html 的帮助文件?
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句