我应该如何使用JSDoc记录Dojo getter和setter?
当声明扩展我应该如何使用JSDoc记录Dojo getter和setter?,dojo,jsdoc,Dojo,Jsdoc,当声明扩展dojo/Stateful的模块时,getter和setter的模式是定义\uxxxgetter和\uxxxsetter,它们将显示为.get('xxx')和.set('xxx') 所以,我的问题是,如何最好地用JSDoc记录这一点@function似乎不支持提供备用方法名,而且无论如何,这是参数值的变体,而不是方法名 那么,JSDoc是否对这个模型有任何内在的支持,或者我是否只需要为这个东西编写明确的文档?那么,如果它只用于生成文档呢?试试这个: 现在可以在变量/函数中堆叠多个文档块
dojo/Stateful
的模块时,getter和setter的模式是定义\uxxxgetter
和\uxxxsetter
,它们将显示为.get('xxx')
和.set('xxx')
所以,我的问题是,如何最好地用JSDoc记录这一点@function
似乎不支持提供备用方法名,而且无论如何,这是参数值的变体,而不是方法名
那么,JSDoc是否对这个模型有任何内在的支持,或者我是否只需要为这个东西编写明确的文档?那么,如果它只用于生成文档呢?试试这个: 现在可以在变量/函数中堆叠多个文档块。不要对此垂头丧气,但我相信语法是这样的:
{
...
/**
* Get varname property
* @returns {mixed}
*//**
* Set varname property
* @param {mixed} val
* @returns {this}
*/
varname: null
...
}
没有IDE intellisence理解dojo.declare或dojo.extend..@mschr:对不起,我不理解你的评论。IntelliSense不是JSDoc。