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 
}()); 

會是什麼@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. 

或者你可以省略類信息，讓讀者來推斷。