dojojs库+；jsdoc->；如何记录代码？

我想问一下开发dojo的人是如何创建文档的

从每晚的构建中，您可以获得包含所有注释的未压缩js文件，并且我确信有某种文档脚本可以从中生成一些html或xml

我猜他们使用jsdoc，因为这可以在他们的utils文件夹中找到，但我不知道如何使用它。jsDoc工具包使用与原始dojo文件不同的

/**注释**/

符号

---

感谢您的帮助

这一切都是通过自定义PHP解析器和Drupal完成的。如果您查看

util/docscripts/README

和

util/jsdoc/INSTALL

可以获得有关如何生成文档的所有详细信息

这和你发现的不同

FWIW，我使用它，因为它更容易生成静态HTML，而且在google代码页上有很多关于标签的文档

---

另外，为了清楚起见，我并没有开发dojo本身。我只是在工作中经常使用它。

dojo jsdoc过程有两个部分。有一个用PHP编写的解析器，它生成所有列出的名称空间的xml和/或json（在util/docscripts/modules中定义，因此您可以添加自己的名称空间。文件“generate.PHP”上有基本的使用说明）和一个名为“jsdoc”的Drupal部分，该部分作为Drupal模块/插件/任何东西安装

它的Drupal方面只是Dojo对这些数据的基本视图。一个精心设计的XSLT或是一些可以在json上迭代并生成html的东西的工作原理是一样的，尽管默认情况下这两个都没有提供（希望有贡献！）。虽然Drupal bit已经在api.dojotoolkit.org上运行了一段时间，但我自己也不敢使用

文档解析器是公开的，因此您可以使用它的检查功能来编写自己的自定义输出。我使用它在一个[相当草率的]PHP文件util/docscripts/makeCix.PHP中生成Komodo.cix代码补全，该文件将找到的信息转储到一个XML文档中，该文档是为匹配那里的规范而编写的。可以对其进行修改，以生成您选择的任何类型的输出，只需稍加欺骗

文档语法都在样式指南页面上定义：