2

コントローラーのメソッドを説明できません。どうすればこれを行うことができますか?

/**
* @ngdoc controller
* @name works.controller:worksCtrl
* @requires $http
* @requires $element
* @function
*
* @description
* Description for works controller. All methods will be writen later
*/
var worksCtrl = function ($http, $element) {

    var ctrl = this;

    //how it do there? this not work
    /** 
        * @name initializeGrid
        * @function
        * @description
        * Description for initializeGrid
    */
    ctrl.initializeGrid = function (a) {
       //...
    }

    ctrl.getTemplate = function (workIndex) {
      //...

    }
    //...
};

ドキュメントの自動生成に ngdoc を使用しています。しかし、私は自分が間違っていることを理解できません。

4

2 に答える 2

4

私は ngdoc を使用したことがありませんが、Angular コード自体を見ると@ngdoc method、内部関数のドキュメントにタグを追加する必要があるようです。たとえば、$locationProvider 内では次のようになります。

  /**
   * @ngdoc method
   * @name $locationProvider#hashPrefix
   * @description
   * @param {string=} prefix Prefix for hash part (containing path and search)
   * @returns {*} current value if used as getter or itself (chaining) if used as setter
   */
  this.hashPrefix = function(prefix) {
    if (isDefined(prefix)) {
      hashPrefix = prefix;
      return this;
    } else {
      return hashPrefix;
    }
  };

お役に立てば幸いです。

于 2015-07-18T08:05:19.530 に答える