JsDoc Toolkit制作 javascript 文档用

[url=http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip]下载[/url]
使用:
java -jar jsrun.jar app/run.js -a -t=templates/jsdoc app/test.js
帮助:
java -jar jsrun.jar app/run.js –help
-a 或者 –allfunctions :为全部函数生成文档,包括那些没有写注释的。
-c 或者 –conf :使用配置文件
-d= 或者 –directory=:指定生成文档的输出目录,默认是 “out”
-e= 或者 –encoding=:指定编码方式
-n 或者 –nocode :忽略所有代码,只为有 @name 标签的注释生成文档。
-o= 或者 –out= : 将日志信息输出到指定文件
-q 或者 –quiet : 不输出任何信息,包括警告。
-t= 或者 –template= :指定文档的模板,这个参数必须提供。
[url=http://code.google.com/p/jsdoc-toolkit/wiki/TagReference]标签详解[/url]

@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: 命名空间
较多用法如下:
eg:
/**
* @fileOverview 功能接口调用
* @author ChenJianxiang
* @constructor BlogJava.Data
* @description [数据结构]命名空间
* @see The Example Project.
* @param {NULL_PARAMETER} objNull
* @param {Function} [fnCallback=”null”] :如果不是函数类型,则进行同步调用
* @return {Boolean} json :作为回调参数返回
* @example new KxEFileMon.Data.NULL_PARAMETER(“a”)
*/

发表评论

电子邮件地址不会被公开。 必填项已用*标注

昵称 *