JavaScript類具有返回此參數的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
}());

在記錄setSomeProperty方法時， @returns標記setSomeProperty ？

Answer 1

它看起來像這樣：

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

{M}指示所返回內容的類別，而<code>this</code>清楚地指示所返回內容。 如果您使用markdown插件：

@returns {M} `this`

更詳細的版本是：

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

或者，您可以省略課程信息，然后讓讀者進行推斷。