dojo js library + jsdoc - >如何记录代码?

bel*_*ebu 6 dojo documentation-generation

我很想问你们开发dojo的人是如何创建文档的?

从夜间构建中,您可以获得带有所有注释的未压缩的js文件,并且我确信有一些类型的文档脚本可以生成一些html或xml.

我猜他们使用jsdoc,因为这可以在他们的utils文件夹中找到,但我不知道如何使用它.jsDoc工具包使用/**commenting**/与原始dojo文件不同的表示法.

感谢你的帮助

set*_*eth 4

这一切都是通过自定义 PHP 解析器和 Drupal 完成的。如果您查看util/docscripts/READMEutil/jsdoc/INSTALL您可以获取有关如何生成文档的所有详细信息。

它与jsdoc-toolkitJSDoc不同(正如您所发现的)。

FWIW,我正在使用jsdoc-toolkit,因为它更容易生成静态 HTML,并且 google 代码页上有很多关于标签的文档。

另外,需要澄清的是,我并不开发 dojo 本身。我只是在工作中经常使用它。