首页 相关文章 Javascript文档生成

Javascript文档生成

  Javascript文档生成是比较头疼的问题,不过现在已经有开源的工具可以使用——JsDoc。

  其官方站点地址:http://jsdoc.sourceforge.net/

  Release版的下载地址是:http://sourceforge.net/projects/jsdoc

  JsDoc是根据Javascript代码中的注释生成相应的帮助文档,它定义了一套注释标签规范。因此在编写Javascript代码时,要根据它能识别的注释标签进行注释。

  具体使用方法如下:

  1、如果操作系统是windows的用户,需要配置perl环境,推荐安装ActivePerl ,Linux/Unix用户则不用配置了。

  2、解压缩JsDoc,在命令提示窗口中进入JsDoc所在目录,使用如下命令即可生成Javascript代码的文档。
perl jsdoc.pl test.js
  其中test.js是用于测试的js文件,如果成功则在该目录下生成js_docs_out目录,里面包含生成的文档。

  3、如果生成失败,产生...[ 查看全文 ]

2016-02-19 标签:

Javascript文档生成的相关文章

手机页面
收藏网站 回到头部