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

Question

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

所以，我的问题是，如何用JSDoc最好地记录这个？ .set('xxx')似乎不支持提供备用方法名称，无论如何，这是参数值的变体，而不是方法名称？

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

Answer 1

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

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

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