javascript - JavaScript 类具有返回 this 的 setter。我如何在 JsDoc 中记录这个？

Question

示例代码：

var myObject = (function() {
    var M;

    M = function() {
    }

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

    return M
}());

@returns记录方法时标签会是什么样子setSomeProperty？

Answer 1

它看起来像这样：

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

{M}表示返回的类别，并<code>this</code>明确表示返回的内容。如果您使用降价插件：

@returns {M} `this`

更详细的版本是：

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

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