【问题标题】:how to place controllers into modules with ngdoc如何使用 ngdoc 将控制器放入模块中
【发布时间】:2014-12-01 20:00:20
【问题描述】:

我使用 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 在不同的文件中。

【问题讨论】:

    标签: angularjs jsdoc


    【解决方案1】:

    通常你为控制器编写 ngdoc:

    @name moduleName.controller:ControllerName

    在你的情况下,你可以写:

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

    【讨论】:

    • 为什么需要额外的.controller:
    • 您也可以写@name moduleName.factory:factoryName 来记录工厂。因此,如果您构建文档,它将把它们全部分开(服务、指令、控制器等)
    猜你喜欢
    • 1970-01-01
    • 2014-07-10
    • 2014-11-10
    • 1970-01-01
    • 1970-01-01
    • 2018-12-23
    • 1970-01-01
    • 1970-01-01
    • 2011-07-04
    相关资源
    最近更新 更多