如何使用ngdoc将控制器放入模块中

时间:2014-10-07 11:43:35

标签: angularjs jsdoc

我使用grunt grunt-ngdocs模块,这是创建文档的代码。

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

我有一个名为starter和两个控制器的模块:controllerA,controllerB

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

  * @description  ...
  */

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

  * @description  ...
  */

运行文档生成器时,这些控制器显示为模块。

如何在ngdoc标记中写入它们,它们都连接到模块启动程序?

contollerA和controllerB在不同的文件中。

1 个答案:

答案 0 :(得分:8)

通常你会以这种方式为控制器编写ngdoc:

  

@name moduleName.controller:ControllerName

在你的情况下你可以写:

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