JsDoc js文档自动生成工具使用详解

JsDoc js文档自动生成工具是google code上的一个开源项目：http://code.google.com/p/jsdoc-toolkit/

 

1.下载解压后，在当前目录下创建一个bat文件run.bat

内容如下：java -jar jsrun.jar app/run.js -a -t=templates/jsdoc todocjs/*.js

如果需要查看运行输出内容的话可以换行后加入pause命令，运行完成后dos屏幕就会暂停在哪里，完整内容如下：

java -jar jsrun.jar app/run.js -a -t=templates/jsdoc todocjs/*.js
pause

 

2.在当前目录下创建todocjs文件夹，把要生成doc的js文件放到这个文件夹下面。todocjs/*.js意思就是把todocjs下所以.js结尾的文件都自动生成doc

 

3.运行run.bat（双击），运行完成后会在当前目录下生成一个out的文件夹，自动生成的jsDoc文件就放在这个目录下，如果只有一个js文件则会在out\jsdoc下

 

4.和其他doc类文件一样，双击index.html就可以看到自动生成的文档了，下面是我生成的一个文档页面：

 

 

Class Index | File Index

---

Classes

• _global_

---

Class Index

_global_

Documentation generated by JsDoc Toolkit 2.3.0 on Thu Jul 16 2009 18:51:14 GMT+0800 (CST)

要自动生成Doc文档，注释必须符合规范，详细信息请看 http://code.google.com/p/jsdoc-toolkit/w/list

用JSEclipse插件编辑js可以像写java代码一样方便有提示地写注释。

下面是各个参数的中文对照说明

@author:作者

@argument:参数

@augments：参数

@class： 类

@constant：常数

@constructor：构造

@constructs： 构造

@default：默认值

@deprecated： 声明不赞成使用该方法（类）

@description：说明

@example ：范例

@extends： 扩展 ，继承

@field：变量

@fileOverview ：文件信息

@function： 功能

@inner 私有，内部

@private : 私有，内部

@ignore： 忽视

@event：事件

@version：版本

@type：类型 描述预期的类型变量的值或返回值的函数

@throws :可能抛出的异常

@static： 静态，访问该变量不需要实例

@since： 自从

@see： 描述相关的资源

@scope ：作用域

@lends： 作用域

@return ：返回值

@returns ：返回值

@requires： 描述必须需要的资源

@public： 说明内在变量是公开的

@property ： 属性

@param：参数

@namespace： 命名空间