如何記錄下面的函數在JSDoc JS-工具包

* 如何記錄下面的函數在JSDoc JS-工具包*如何記錄下面的函數在JSDoc JS-工具包

我想記錄嘗試和幫助方法在此主要功能但我沒有弄清楚如何做到這一點。

/** Sample doc 
* @class 
* @constructor 
* @name Sample 
*/ 
var main=function(){ 
    this.value=""; 

    /** help function 
    * @param {String} Name 
    */ 
    this.help=function(name){ 
    console.log('help me'+name); 
    } 

    /** help function 
    * @param {String} Name 
    */ 
    this.try=function(name){ 
    console.log('try me'+name); 
    } 

}

來源

2013-04-05 Pradeep

我剛剛爲此奮鬥了幾個小時。我想：

@member
@augments
@method
@this

從例子和教程我發現，成員函數和變量應該簡單地出現在輸出通過具有/** description/*以上的評論，但我發現並非如此。和你一樣，我使用標準的JavaScript構造函數，其中this應該能夠自動推斷，因爲@constructor已到位。也許我看不到一些皺紋。

最後，我發現了兩個標籤，對我而言，@name和@memberof。它們都允許您指定屬性所屬的對象。以這種方式使用@name沒有記錄（至少，我沒有看到它在任何地方），但非常簡單。您還需要使用@function。

下面是與@name標籤的例子：

/** help function 
* @name Sample.try 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
};

enter image description here

這裏是一個與@memberof標籤的例子：

/** help function 
* @memberof Sample 
* @function 
* @param {String} Name 
*/ 
this.try=function(name){ 
    console.log('try me'+name); 
};

enter image description here

正如你所看到的輸出幾乎相同。我看到的唯一區別是@memberof在方法名稱中包含this.。出於這個原因，我已經決定使用@name。

剩下的問題是函數是每個實例，而不是<static>。

希望這會有所幫助！

來源

2013-06-19 14:21:55 mwcz

如何記錄下面的函數在JSDoc JS-工具包

回答

相關問題