車把幫手的JSdoc doclet

我有一個JSdoc設置了我正在構建的一個小應用程序。我最近開始將doclet添加到我的handlebar幫助程序文件中，但我在正確註釋模式時遇到了麻煩。車把幫手的JSdoc doclet

/** 
* My helper Name 
* My helper description 
* 
* @method myHandlebarsHelper 
* @param options.hash.data {object} - some object 
* @param options.hash.param {string} - some string 
* @returns {string} some output string 
**/

另外，我想確保handlebars助手在doc輸出中有自己的自包含部分。目前所有內容都輸出到全局部分。我應該使用@namespace還是@external來完成此操作？

在此先感謝

來源

2015-04-03 am80l

這取決於你想如何構建你的項目。您可以將所有助手放在自己的部分中。或者將不同的助手與他們相關的其他代碼分組。 – 2015-04-03 20:34:42

我想我的問題是我不知道如何爲少數的.js文件創建一個獨特的部分。我對jsDoc非常陌生，所以它可能我正在考慮這個錯誤：/ – am80l 2015-04-03 23:52:38

你可以使用@externals或另一種方法是記錄一個（假的）模塊將即

/** @module handlebars */

一個文件的頂部和文檔的所有助手成爲其中的成員模塊。我的語法不正確，但它會很好地分離。

同樣你可以使用一個命名空間

/** @namespace HandlebarsHelper */

並記錄所有成員

/** 
* My helper Name 
* My helper description 
* 
* @method HandlebarsHelper.myHandlebarsHelper 
* @param options.hash.data {object} - some object 
* @param options.hash.param {string} - some string 
* @returns {string} some output string 
**/

來源

2015-04-08 11:45:59 SGD

車把幫手的JSdoc doclet

回答

相關問題