Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/javascript/426.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Javascript 如何为角度组件注释ngdoc?_Javascript_Angularjs_Angular Components_Ngdoc - Fatal编程技术网

Javascript 如何为角度组件注释ngdoc?

Javascript 如何为角度组件注释ngdoc?,javascript,angularjs,angular-components,ngdoc,Javascript,Angularjs,Angular Components,Ngdoc,我正在编写一个AngularJS组件,我想知道向组件本身和控制器函数添加ngdoc注释的正确方法是什么 您有任何示例吗?您应该使用@ngdoc overview进行模块定义。控制器为@ngdoc controller,服务为@ngdoc service 模块 /** * @memberof dugun.leads * @ngdoc module * @description * Leads mean info requsts and inbound calls */ angular.m

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


您有任何示例吗?

您应该使用
@ngdoc overview
进行模块定义。控制器为
@ngdoc controller
,服务为
@ngdoc service

模块

/**
 * @memberof dugun.leads
 * @ngdoc module
 * @description
 * Leads mean info requsts and inbound calls
 */
angular.module('dugun.leads', [
    // vendor
    'ngRoute',
    'dugun.notifications',
    'dugun.queryString',
    'dugun.search',
    // app
    'dugun.helpers.tableSort',
    'dugun.forms',
    'dugun.leads.infoRequests',
    'dugun.leads.calls'
]);
/**
 * @memberof dugun.leads
 * @ngdoc route
 * @name LeadRoutes
 * @param $routeProvider {provider} $routeProvider
 *
 * @description /providers/:providerId/info
 */
function LeadRoutes($routeProvider) {
    $routeProvider
        .when('/leads', {
            templateUrl: 'leads/list.html',
            controller: 'LeadListCtrl',
            controllerAs: 'leadListCtrl',
            label: 'Çiftler',
            reloadOnSearch: false
        });
}
路线

/**
 * @memberof dugun.leads
 * @ngdoc module
 * @description
 * Leads mean info requsts and inbound calls
 */
angular.module('dugun.leads', [
    // vendor
    'ngRoute',
    'dugun.notifications',
    'dugun.queryString',
    'dugun.search',
    // app
    'dugun.helpers.tableSort',
    'dugun.forms',
    'dugun.leads.infoRequests',
    'dugun.leads.calls'
]);
/**
 * @memberof dugun.leads
 * @ngdoc route
 * @name LeadRoutes
 * @param $routeProvider {provider} $routeProvider
 *
 * @description /providers/:providerId/info
 */
function LeadRoutes($routeProvider) {
    $routeProvider
        .when('/leads', {
            templateUrl: 'leads/list.html',
            controller: 'LeadListCtrl',
            controllerAs: 'leadListCtrl',
            label: 'Çiftler',
            reloadOnSearch: false
        });
}
控制器

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

据我所知,您不能使用
ng doc
的主版本来记录
组件

制作了一个ng doc的叉子,并支持角形组件:

* @ngdoc component
* @name app.component:guideItem
*
* @description
* This component shows cards using the item binding for his own building.
*
* @param {object}  item      A object with card data 

这里有一个例子:

controller.js:

/**
 * @this vm
 * @ngdoc controller
 * @name dragDropRelation.controller:draggableItemController
 *
 * @description
 *  Controller for the draggableItem component
 */
export default function draggableItemController() {

}
component.js:

import controller from './controller.js';
import templateUrl from './view.html';
/**
 * @ngdoc component
 * @name dragDropRelation.component:draggableItem
 *
 * @description
 * Component that allows to be dragged containing some data.
 * @param {Boolean} used Used flag
 * 
 * @param {String} text Text to display
 * @param {Object} data Data to be saved
 * 
 * @param {Boolean} disabled variable to disable the component
 */
export const component = {
  templateUrl: templateUrl,
  controller: controller,
  bindings: {
    used: '<?',
    text: '<',
    data: '<',
    disabled: '<?',
  },
};
从“/controller.js”导入控制器;
从“./view.html”导入templateUrl;
/**
*@ngdoc组件
*@name dragDropRelation.component:draggableItem
*
*@说明
*允许拖动包含某些数据的组件。
*@param{Boolean}已使用标志
* 
*@param{String}要显示的文本
*@param{Object}要保存的数据
* 
*@param{Boolean}禁用变量以禁用组件
*/
导出常量组件={
templateUrl:templateUrl,
控制器:控制器,
绑定:{

used:“只是为了澄清:你问的是当你用
.component()
方法编写angular 1.5.x组件时,对吗?我想问题是,你如何在angular 1.5.x中向
.component()
添加ng文档注释。我不确定你是如何回答这个问题的。你能澄清一下吗?”?