dojo - 我应该如何使用 JSDoc 记录 Dojo getter 和 setter？

Question

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

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

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

Answer 1

那么，如果它仅用于生成文档？试试这个：https ://github.com/jsdoc3/jsdoc

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

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