2014-10-07 41 views
4

我使用grunt grunt-ngdocs模塊,這是創建文檔的代碼。如何將控制器放入ngdoc模塊中

ngdocs: { 
      all: app_files, 
      scripts: ['angular.js'] 
     } 

我有一個模塊調用啓動器和兩個控制器:controllerA,controllerB

/** 
    * 
    * @ngdoc object 
    * @name controllerA 

    * @description ... 
    */ 

/** 
    * 
    * @ngdoc object 
    * @name controllerB 

    * @description ... 
    */ 

當運行文檔生成這些控制器被示出爲模塊。

我如何將它寫入ngdoc標記中,它們都連接到模塊啓動器?

contollerA和controllerB在不同的文件中。

回答

8

通常你寫ngdoc這樣的控制器:

@name moduleName.controller:ControllerName

在你的情況,你可以這樣寫:

/** 
* @ngdoc controller 
* @name starter.controller:controllerA 
* 
* .... 
*/ 
+0

爲什麼是多餘' .controller:'必要的? – schmod 2016-05-12 18:34:25

+0

您還可以編寫'@name moduleName.factory:factoryName'來記錄工廠。所以,如果你構建文檔,它將分離所有的文檔(服務,指令,控制器等) – DevTrong 2016-05-17 07:08:42

相關問題