擴展jsDoc來處理自定義標籤

我期待擴展jsdoc（特別是docstrap）。我有一個nodeJS應用程序，並希望將jsdoc導航分割爲控制器，視圖等。我已經在一定程度上通過創建我的自定義標籤（如@controller），並設法讓它被類似於@module的JsDoc捕獲，因此它生成頁面（與描述）。然而，我的問題是，當涉及到與例如與'module.exports'功能位於控制器相關的功能。生成的文檔基本上忽略了@controller文件中的任何其他功能。我如何捕獲這些功能。擴展jsDoc來處理自定義標籤

下面是這樣一個例子：

/** 
* @controller my_controller 
*/ 
module.exports = { 
    /** 
    * @description my function 
    */ 
    myFn : function(){ 

    } 
}

來源

2015-05-11 user584569

到目前爲止，我得到這個工作的唯一方法是使用'@memberof controller：my_controller'。任何其他選項？ – user584569

發生了什麼，我在相似背景的工作是使用一個插件，它有效地標記，當它被標記爲controller元素作爲module。通過這種方式，您可以獲得類似模塊的行爲，然後在渲染模塊時只需排除模型，視圖和控制器。

我必須修補很多地方纔能使之起作用，否則由於有些行爲只是綁定到modules而且頂部沒有抽象可以觸發相同的行爲。

來源

2015-05-19 07:01:12 SGD

你可以分享你的配置嗎？ –

擴展jsDoc來處理自定義標籤

回答

相關問題