如何为Angular组件注释ngdoc？

Question

我正在编写一个AngularJS组件,我想知道将ngdoc注释添加到组件本身和控制器功能的正确方法是什么.

你有什么例子吗？

Answer 1

您应该用于@ngdoc overview模块定义。对于@ngdoc controller控制器，@ngdoc service对于服务。

\n\n

模块

\n\n

/**\n * @memberof dugun.leads\n * @ngdoc module\n * @description\n * Leads mean info requsts and inbound calls\n */\nangular.module('dugun.leads', [\n    // vendor\n    'ngRoute',\n    'dugun.notifications',\n    'dugun.queryString',\n    'dugun.search',\n    // app\n    'dugun.helpers.tableSort',\n    'dugun.forms',\n    'dugun.leads.infoRequests',\n    'dugun.leads.calls'\n]);\n

\n\n

路线

\n\n

/**\n * @memberof dugun.leads\n * @ngdoc route\n * @name LeadRoutes\n * @param $routeProvider {provider} $routeProvider\n *\n * @description /providers/:providerId/info\n */\nfunction LeadRoutes($routeProvider) {\n    $routeProvider\n        .when('/leads', {\n            templateUrl: 'leads/list.html',\n            controller: 'LeadListCtrl',\n            controllerAs: 'leadListCtrl',\n            label: '\xc3\x87iftler',\n            reloadOnSearch: false\n        });\n}\n

\n\n

控制器

\n\n

/**\n * Controls Provider\n * @constructor\n * @ngdoc object\n * @memberof dugun.leads\n * @name LeadListCtrl\n * @scope\n * @requires $scope {service} controller scope\n * @requires $route {service} $route\n * @requires $window {service} $window\n * @requires $filter {service} $filter\n * @requires dgNotifications {service} dgNotifications\n * @requires moment {service} moment\n * @requires queryString {service} dugun.queryString:queryString\n * @requires Analytics\n * @requires Leads {factory} Leads service\n */\nfunction LeadListCtrl($scope, $route, $window, $filter,\n                      dgNotifications, queryString, moment, Analytics,\n                      Leads)\n

\n