Javascript JSDoc：如何避免属性/getter的重复文档？

我目前正在使用JSDoc记录我的一个API。虽然这样做很好，但有一件事让我非常恼火，那就是出现了重复的文档。一个常见的例子是属性及其getter的文档：

function AClass() {
    /**
     * The current state of the object. Determines wether this object has been initialized yet.
     * @type {String}
     * @private
     */
    this._state = "initalized";
}

/**
 * Returns the current state of the object, which determines if the object has been initalized yet.
 * @return {String} The current state of the object
 */
AnObject.prototype.getState = function() {
    return this._state;
}

我想大家都看到了这个问题。该属性实际上记录了三次（私有属性本身、getter方法描述和方法的返回值）。 简单地将方法的描述更改为类似于

的返回状态

实际上不是一个选项，因为我通常在文档输出中隐藏私有属性

---

我感兴趣的是，对于这种情况是否有最佳做法，以及其他人如何处理。作为一个沉迷于干燥的人，似乎应该有一个更好的选择来处理这些案件。

我也注意到了这一点，并同意这有点恼人，同时我认为没有一个完美的解决办法

你能做的大概是

/**
 * Getter for {@link AClass._state}
 * @return {String} Returns {@link AClass._state}
 */