问题标签 [help-files]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
106 浏览

sandcastle - 处理 MSDN 样式帮助文件的 xml 文档代码注释中的自定义 xml 元素

我正在寻找一种方法来构建包含大型项目的自定义 XML 元素的帮助文件。我想添加我自己的类似于 Summary 元素的元素,并让帮助文件包含它。我安装了 Sandcastle 和 Ghost Doc Pro。我一直无法找到让这些帮助文件构建器中的任何一个包含我的自定义标签的方法。一个例子:

如果有人可以让我引导我找到文档以将自定义元素包含在文档中,那就太好了。

0 投票
1 回答
31 浏览

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

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

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

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