JavaScript XML 注释文档答案

【问题标题】：JavaScript XML Comment DocumentationJavaScript XML 注释文档
【发布时间】：2010-11-01 04:14:27
【问题描述】：

我正在构建一个自定义的复合控件库，其中包含自己的 JavaScript 文件作为 Web 资源。我已经运行 DocProject 来生成我的 XML 文档 CHM，它运行良好。

但是，当我将解决方案设置为“发布”配置时，运行时仍然没有从嵌入的 JavaScript 文件中提取 XML cmets 并将它们包含在生成的 cmets.xml 文件或 .org 反射文件中。因此，当我运行我的 DocProject 构建时，我包含在我的 JavaScript 文件中的 cmets 被排除在外，这使得我的文档不完善。

有什么想法吗？我希望能够将 JavaScript 文档直接包含在生成的 CHM 中。

从那以后，我在 CodePlex 上查看了 AjaxDoc，但在大约 6 小时后还没有成功。是的，我已经联系了 Bertrand LeRoy（AjaxDoc 的创建者），希望能得到回复，尽管我确信他很忙。

【问题讨论】：

标签： .net javascript xml documentation comments

【解决方案1】：

您的问题似乎与 javascript 或 xml 本身没有任何关系，而是您可能希望在标签中添加的 DocProject。

【讨论】：

.NET 框架生成的 .XML 文件没有导出 javascript 文件中的 XML cmets。搞砸的不是DocProject，而是我的“JAVASCRIPT”文件的“XML”“COMMENTS”没有出现在“.NET”生成的“DOCUMENTATION”文件中。也许现在你会理解标签了。 :)

【解决方案2】：

几点可以帮助你理解发生了什么：

XML doc 文件是根据已编译源代码的 cmets 构建的。 Javascript 未编译。

Visual Studio 对 JS 上的 xml 文档的唯一支持是在用于智能感知和代码完成的 JS 代码编辑器窗口中。就是这样。

AjaxDoc 是一个相当复杂的野兽，它只适用于使用 MsAjax 构建并利用它的打字系统的 JS。

AjaxDoc 无法为 POJO (plain ole' javascript) 构建 xml 文件

我不会屏住呼吸等待 Betrand 的任何回应。

我目前正在开发 POJO 文档引擎，但我的工作让我很忙。您可以在this download的/docs目录中看到一个浏览器内按需文档构建原型

对不起，新闻没有更好。

【讨论】：