加载中...

jsDoc的使用

nodeJS使用：

直接：npm install jsdoc -g
使用：jsdoc [name].js

简介

JsDoc Toolkit 是一款辅助工具，你只需要根据约定在 JavaScript 代码中添加相应的注释，它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像，没错，JsDoc Toolkit 就是基于 JavaDoc 开发的。

下载地址

http://code.google.com/p/jsdoc-toolkit/

目录结构

  • app : 存放的是js文件。包括一些实例文件和读取js和模板生成文档的js文件。
  • conf : 提供默认的配置的文件。
  • java : 存放的是“rhino”这是一个脚本java写的javascript脚本引擎，用来提供js的运行环境。
  • templates : 存放生成文档的模板，根据不同的模板可以生成html xml等各种类型文档。
  • jsrun.jar，jsdebug.jar : 生成的入口调用了rhino框架和js文件

工作模式

通过一段java代码（jsrun.jar）调用rhino框架（该框架提供了一个运行javascript的环境），然后再运行javascript读取生成文档的javascript文件和模板文件生成文档。

注释标签

这里的标签是指约定的注释标签，只有写了这些标签， JsDoc Toolkit 才能根据这些标签来生成正确的文档，比如在 @example 之后跟一段小的代码例子。

可用标签列表：http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

使用

首先切换到当前目录下，windows执行下面命令

> java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js

Mac OS或Linux执行西面命令

$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js

如果成功的话，你就会看到当前文件夹里多出了一个叫做 out 的文件夹，生成的文档就在里面了！然后你就可以在浏览器中查看了。

说明：

  • “java -jar jsrun.jar app/run.js” ：固定代码，每次运行时都必须含有的。
  • -a 或者 –allfunctions ：为全部函数生成文档，包括那些没有写注释的。
  • -c 或者 –conf ：使用配置文件
  • -d= 或者 –directory=：指定生成文档的输出目录，默认是 “out”
  • -e= 或者 –encoding=：指定编码方式
  • -n 或者 –nocode ：忽略所有代码，只为有 @name 标签的注释生成文档。
  • -o= 或者 –out= ： 将日志信息输出到指定文件
  • -q 或者 –quiet ： 不输出任何信息，包括警告。
  • -t= 或者 –template= ：指定文档的模板，这个参数必须提供

查看帮助

$ java -jar jsrun.jar app/run.js --help

Rhino

Mozilla's Rhino JavaScript runtime engine.官网：http://www.mozilla.org/rhino/,该单词的意思是犀牛。

参考文章

posted @ 2016-08-19 12:00  水车  阅读(1249)  评论(0)  编辑  收藏  举报