更正ngdocs的代码格式,特别是在处理ES6模块时

时间:2016-01-04 12:46:56

标签: angularjs ecmascript-6

我正在学习ngdocs并开始在我的网站上实现它,尽管我很难找到一个合适的例子来作为指导。特别是,我使用ES6模块进行Angular构建,但没有一个例子涵盖了这一点。我的问题是哪个应该首先出现,'使用严格'和导入或初始ngdocs评论?关于如何制定这些事情,是否有一条硬性规定?

我在下面汇总了一个示例指令,它看起来不错吗?怎么能更好地评论?我希望能够对此进行详细介绍,因为一旦我完成了这项工作,我希望能够有更好的理解。提前谢谢。

/**
 * @ngdoc directive
 * @name Comments.directive:comments
 * @restrict E
 *
 * @description
 * Comments block for adding comments and replies
 *
 * @param {service} $compile
 * @param {service} $templateCache
 */
'use strict';

import commentsController from './comments.controller';
import template from './comments.tpl.html!text';

function commentsDirective($compile, $templateCache) {
  return {
    restrict: 'E',
    scope: true,
    bindToController: true,
    controllerAs: 'ctrl',
    controller: commentsController,
    template: template,
    replace: true,
    link: function(scope, element, attrs) {
      /**
       * @ngdoc method
       * @name onClick
       * @methodOf Comments.comments
       * @description
       * Example to show commenting for a method within a directive
       *
       * @param {MouseEvent} e
       * @returns {String} Returns the String 'hello'
       */
      function onClick(e){
        // example function
        return 'hello';          
      }

      element.on('click', onClick);
    }
  };
}

commentsDirective.$inject = ['$compile', '$templateCache'];

export default commentsDirective;

0 个答案:

没有答案