当前位置 : 主页 > 网页制作 > Dojo >

dojo js库jsdoc – >如何记录代码?

来源:互联网 收集:自由互联 发布时间:2021-06-15
我很想问你们开发dojo的人是如何创建文档的? 从夜间构建中,您可以获得带有所有注释的未压缩的js文件,并且我确信有一些类型的文档脚本可以生成一些html或xml. 我猜他们使用jsdoc,因为
我很想问你们开发dojo的人是如何创建文档的?

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

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

感谢你的帮助

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

它与jsdoc-toolkit或JSDoc不同(正如您所发现的那样).

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

另外,为了清楚起见,我不开发道场本身.我只是在工作中使用它.

网友评论