Javascript 具有多个签名的文档构造函数
我想知道如何使用jsdoc为构造函数定义两个签名:Javascript 具有多个签名的文档构造函数,javascript,jsdoc,Javascript,Jsdoc,我想知道如何使用jsdoc为构造函数定义两个签名: makeClass("Person", /** @lends Person */ { /** @constructs @param {int} p1 */ /** @constructs @param {string} p1 */ constructor: function () { }, /** @nam
makeClass("Person",
/** @lends Person */
{
/**
@constructs
@param {int} p1
*/
/**
@constructs
@param {string} p1
*/
constructor: function () {
},
/**
@name Person.prototype.func
@function
@param {object} arg arg desc
*/
/**
@name Person.prototype.func^2
@function
@param {int} arg arg desc
@param {int} arg2 arg2 desc
*/
func: function () {
}
});
这将生成一个具有{string}p1的构造函数
感谢您的帮助JSDoc没有一个可与visualstudio XML Doc多签名相媲美的概念。一种选择是将参数记录为具有多种可能的类型,并标记一些可选参数
/**
* @param {Number|Object} arg Description of arg
* @param {Number} [arg2] Description of arg2
*/
,项目使用/创建的文档工具具有,允许您为同一方法注释多个签名
我找不到太多,但根据(为简洁而编辑的)报告,它看起来很简单:
/**
* @signature `observe.attr()`
* @return {Object<String, *>} an object with all the properties in this `can.Observe`.
*
* @signature `observe.attr(key)`
* @param {String} key the property to read
* @return {*} the value assigned to _key_.
*
* @signature `observe.attr(key, value)`
* @param {String} key the property to set
* @param {*} the value to assign to _key_.
* @return {can.Observe} this Observe, for chaining
*/
attr: function( attr, val ) {
/**
*@signature`observe.attr()`
*@return{Object}具有此“can.Observe”中所有属性的对象。
*
*@signature`observe.attr(密钥)`
*@param{String}为要读取的属性设置密钥
*@return{*}分配给_key的值。
*
*@signature`observe.attr(键,值)`
*@param{String}为要设置的属性设置键
*@param{*}要分配给_key\的值。
*@return{can.Observe}此观察,用于链接
*/
属性:函数(属性,值){