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