JavaScript类有setter返回它。我如何在JsDoc中记录这个?

时间:2014-02-07 16:05:16

标签: javascript jsdoc jsdoc3

示例代码:

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标记会是什么样的?

1 个答案:

答案 0 :(得分:1)

看起来像这样:

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

{M}表示返回的类,<code>this</code>清楚地表明返回的内容。如果您使用markdown插件:

@returns {M} `this`

更详细的版本是:

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

或者您可以省略班级信息并让读者推断出来。