JavaScript类具有返回此值的setter。我如何在JsDoc中记录这一点？

示例代码：

var myObject = (function() {
    var M;

    M = function() {
    }

    M.prototype = {
        constructor: M,
        setSomeProperty = function(someValue) {
            // Do Stuff
            return this; // For chaining purposes
        }
    }

    return M
}());

---

当记录

setSomeProperty

方法时，

@returns

标记会是什么样子？

它会是这样的：

@returns {M} <code>this</code>

{M}

表示返回内容的类别，而

此

明确表示返回的内容。如果您使用markdown插件：

@returns {M} `this`

更详细的版本是：

@returns {M} The instance on which this method was called.

---

或者你可以省略类信息，让读者推断出来。

我更喜欢最后一个版本。文档化的思想是记录代码，而不是简单地逐字重复。就在昨天，我遇到了一个库，其中有

@returns
这个

本可以立即理解并非常有用。仅仅阅读代码（这通常是在这些情况下给出的pat响应）并不能说明问题，因为顶级方法正在执行

返回此值。其他方法（…）

，正在执行

返回此值。但是另一个（…）

，等等。在文档中使用

@返回
此
（反正我正在阅读）就像在自动生成的文档中有意义的描述性文档注释一样，远离代码本身。