我应该如何使用 JSDoc 记录 Dojo getter 和 setter？答案

【问题标题】：How should I document Dojo getters and setters using JSDoc?我应该如何使用 JSDoc 记录 Dojo getter 和 setter？
【发布时间】：2012-08-21 15:51:38
【问题描述】：

在声明扩展dojo/Stateful 的模块时，getter 和setter 的模式是定义_xxxGetter 和_xxxSetter，它们将表现为.get('xxx') 和.set('xxx')。

所以，我的问题是，如何最好地用 JSDoc 记录这个？ @function 似乎不支持提供替代方法名称，而且无论如何，这是参数值的变体，而不是方法名称？

那么，JSDoc 是否对这个模型有任何内在的支持，还是我只需要为这些东西编写明确的文档？

【问题讨论】：

没有 IDE 智能理解 dojo.declare 或 dojo.extend..
@mschr：对不起，我不明白你的评论。 IntelliSense 不是 JSDoc。

标签： dojo jsdoc

【解决方案1】：

如果它单独用于生成文档？试试这个：https://github.com/jsdoc3/jsdoc

现在可以堆叠多个文档块 pr 变量/函数。不要在这上面挂我的头 - 但我相信语法是这样的：

{
 ...
 /**
  * Get varname property
  * @returns {mixed}
  *//**
  * Set varname property
  * @param {mixed} val
  * @returns {this}
  */
  varname: null
 ...
}

【讨论】：