代码之家 › 专栏 › 技术社区 › belzebu

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

documentation-generation dojo

6

belzebu · 技术社区 · 17 年前

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

从夜间构建中,您可以得到包含所有注释的未压缩JS文件,我确信有某种文档化脚本可以从中生成一些HTML或XML。

我想他们使用jsdoc,因为这可以在他们的utils文件夹中找到,但我不知道如何使用它。JSDoc工具包使用不同的 /**commenting**/ 原始Dojo文件以外的注释。

谢谢你的帮助

2 回复 | 直到 15 年前

1

4

seth 17 年前

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

它不同于 jsdoc-toolkit 或 JSDoc (正如你发现的那样)。

我正在使用 JSDoc工具包因为生成静态HTML要容易得多,而且谷歌代码页上有很多关于标签的文档。

另外,要明确一点,我不开发Dojo本身。我只是在工作中经常使用它。

2

4

Kyle Hayes 15 年前

“Dojo JSDoc”过程有两个部分。有一个用PHP编写的解析器,它生成所列出的全部名称空间(在util/docscripts/modules中定义)的XML和/或JSON,因此您可以添加自己的名称空间。在文件“generate.php”)的顶部有一些基本的用法说明,还有一个叫做“jsdoc”的drupal部分,它安装为drupal模块/插件/任何东西。

它的Drupal方面只是Dojo对此数据的基本视图。一个精心设计的XSLT或者一些可以在JSON上迭代并生成HTML的东西,其工作原理是一样的,尽管默认情况下两者都没有提供(希望有贡献!).I回避Drupal咬我自己,尽管它已经在api.dojotoolkit.org上运行了一段时间。

文档分析器是公开的,这样您就可以使用它的检查功能来编写自己的自定义输出。我使用它在一个[相当草率]的php文件util/docscripts/makecix.php中生成komodo.cix代码完成,该文件将找到的信息转储到一个XML文档中,该文档经过精心设计以匹配那里的规范。可以对其进行修改,以生成您选择的任何类型的输出,只需稍加修饰即可。

文档语法都在样式指南页上定义: http://dojotoolkit.org/reference-guide/developer/styleguide.html