我很想问你们开发dojo的人是如何创建文档的?
从夜间构建中,您可以获得包含所有注释的未压缩js文件,并且我确信有一些类型的文档脚本可以生成一些html或xml。
我猜他们使用jsdoc,因为这可以在他们的utils文件夹中找到,但我不知道如何使用它。 jsDoc工具包使用与原始dojo文件不同的/**commenting**/
符号。
感谢您的帮助
答案 0 :(得分:4)
这一切都是使用自定义PHP解析器和Drupal完成的。如果你查看util/docscripts/README
和util/jsdoc/INSTALL
,就可以获得有关如何生成文档的所有详细信息。
与jsdoc-toolkit或JSDoc不同(正如您所发现的那样)。
FWIW,我正在使用jsdoc-toolkit,因为生成静态HTML要容易得多,并且谷歌代码页上有很多关于标签的文档。
另外,为了清楚起见,我不开发道场本身。我只是在工作中使用它。
答案 1 :(得分:4)
“dojo jsdoc”过程分为两部分。有一个用PHP编写的解析器,它生成整个列出的命名空间的xml和/或json(在util / docscripts / modules中定义,因此你可以添加自己的命名空间。文件顶部有基本的使用说明“generate。 php“)和一个名为”jsdoc“的Drupal部分,它安装为drupal模块/插件/无论如何。
Drupal方面只是Dojo对此数据的基本视图。一个精心设计的XSLT或迭代json并生成html的东西也会起作用,虽然这些都不是默认提供的(会喜欢贡献!)。我自己回避了Drupal,尽管它已经在api.dojotoolkit.org上运行了一段时间。
公开了doc解析器,以便您可以使用其检查功能编写自己的自定义输出。我使用它来生成一个[相当粗糙的] PHP文件util / docscripts / makeCix.php中的Komodo .cix代码完成,它将找到的信息转储到一个XML文档中,以便与那里的规范相匹配。这可以修改为生成您选择的任何类型的输出,只需要一点点。
doc语法全部在样式指南页面上定义: http://dojotoolkit.org/reference-guide/developer/styleguide.html