如何正確地爲修改String原型的內聯函數編寫JSDoc？

Question

如何正確記錄擴展String對象原型的函數？例如：

if (!String.prototype.format) { 
    /** 
    * @name String.prototype.format 
    * Replaces symbols like {0}, {1} in a string with the values from the arguments. 
    */ 
    String.prototype.format = function() { 
     var args = arguments; 
     return this.replace(/{(\d+)}/g, function (match, number) { 
      return typeof args[number] != 'undefined' 
       ? args[number] 
       : match 
      ; 
     }); 
    }; 
} 

我嘗試了使用和不使用@function和@name註釋。

它不起作用，因爲Visual Studio 2017不會像添加JSDoc註釋時那樣開始顯示帶有函數描述的工具提示。

Answer 1

這是否工作

if (!String.prototype.format) { 
    /** 
    * @namespace String 
    */ 

    /** 
    * @memberof String 
    * @name String#format 
    * @function 
    * Replaces symbols like {0}, {1} in a string with the values from the arguments. 
    */ 
    String.prototype.format = function() { 
     var args = arguments; 
     return this.replace(/{(\d+)}/g, function (match, number) { 
      return typeof args[number] != 'undefined' 
       ? args[number] 
       : match 
      ; 
     }); 
    }; 
}