JavaScript XML评论文档

时间:2009-06-08 13:00:46

标签: .net javascript xml documentation comments

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

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

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

我已经查看了CodePlex上的AjaxDoc,并且在大约6个小时后没有成功。是的,我已经联系了Bertrand LeRoy(AjaxDoc的创建者)并希望能够听到回复,但我确信他很忙。

2 个答案:

答案 0 :(得分:0)

您的问题似乎与javascript或xml本身无关,而是您可能希望在标记中添加的DocProject。

答案 1 :(得分:0)

可以帮助您了解正在发生的事情的几点:

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

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

AjaxDoc是一个相当复杂的野兽,仅适用于使用MsAjax构建并利用其输入系统的JS。

AjaxDoc无法为POJO(plain ole'javascript)

构建xml文件

对于Betrand的回应,我不会屏住呼吸。

我目前正在研究POJO文档引擎,但我的工作让我很忙。您可以在this download

的/ docs目录中查看浏览器内按需doc文档构建原型

对不起,这个消息并不好。