标签语法
/**
* <描述信息>
* @<标签名称> <标签信息[可多行]>
*/
/**
* 这里是元素、属性的描述信息.
* 更多描述信息
* @public
* @constructor
* @param <number> arg1 这里可以加上参数描述信息
* @param <number> arg2
* @param
*/
Math.max = function(arg1,arg2){
return arg1>arg2?arg1:arg2;
}
常用标签参考
访问修饰(只是文档作用,没有语法限制)
- @public: 公开元素，任何地方可以使用该元素
- @private: 私有元素，装载单元（文件）内部使用
- @protected: 保护元素，只能是继承它的子类调用（javascript原型继承）
- @friend: 友元元素，可以在任何地方使用， 但是使用它意味着，你和这个类库紧密的关系，可以看成一种高级功能
- @intenal: 内部元素，只能在这个类库内部使用，不建议第三方访问的元素
函数信息
- @param: 函数参数信息,如示例
- @return: 函数返回类型信息，与@param 不同的是，无需名称
/**
* 这里是元素、属性的描述信息.
* 更多描述信息
* @public
* @constructor
* @param <number> arg1 这里可以加上参数描述信息
* @param <number> arg2
* @param
*/
Math.max = function(arg1,arg2){
return arg1>arg2?arg1:arg2;
}
类型暗示
- @constructor: 标识该元素为类（JS中叫构造器）
- @typeof: 指定原始类型信息，类比javascript typeof 运算符
- @instanceof: 指定类信息，类比javascript instanceof 运算符
/**
* 这里是元素、属性的描述信息.
* 更多描述信息
* @public
* @constructor
* @param <number> arg1 这里可以加上参数描述信息
* @param <number> arg2
* @param
*/
Math.max = function(arg1,arg2){
return arg1>arg2?arg1:arg2;
}
ID暗示
- @owner: 指定某个属性的归属对象【常用于一些动态代码导致自动查找归属失败时】
- @id: 直接指定文档对应的脚本元素id，用于没有确定代码的脚本元素，支持*匹配
/**
* 输出<b>[$1]</b>级别的日志信息
* 这是JSI $log对象的文档
* @public
* @param <object> arg1 第一个参数
* @param <object> arg2 第一个参数
* @arguments <object>arg... 第N个参数
*
* @id $log.*
*/