当声明一个扩展 dojo/Stateful
的模块时,getters 和 setters 的模式是定义 _xxxGetter
和 _xxxSetter
将被显示作为 .get('xxx')
和 .set('xxx')
。
所以,我的问题是,如何最好地使用 JSDoc 记录这一点? @function
似乎不支持提供备用方法名称,无论如何,这是参数值的变体,而不是方法名称?
那么,JSDoc 是否对这种模型有任何固有的支持,或者我是否只需要为这些东西编写明确的文档?
最佳答案
那么它是否仅用于生成文档?试试这个:https://github.com/jsdoc3/jsdoc
现在可以堆叠多个文档 block pr 变量/函数。不要对此犹豫不决 - 但我相信语法是这样的:
{
...
/**
* Get varname property
* @returns {mixed}
*//**
* Set varname property
* @param {mixed} val
* @returns {this}
*/
varname: null
...
}
关于dojo - 我应该如何使用 JSDoc 记录 Dojo getter 和 setter?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12022435/