angularjs - angularJS でのコントローラー プロパティでの ngdocs の使用

Question

私は角度のあるアプリケーションに grunt-ngdocs を使用して把握し始めたばかりで、これまでのところうまくいっています。

しかし、コントローラーの 1 つで別の文書化されたプロパティのいくつかのプロパティを文書化したいと思います。

次のコードを検討してください。

(function() {
  'use strict';
  /**
   * @ngdoc controller
   * @name app.mymodule.controller:MyController
   * @description
   * A Controller
   */
  angular
      .module('app.mymodule')
      .controller('MyController', Controller);

  Controller.$inject = ['someService', 'otherService', '$state'];

  function Controller(someService, otherService, $state) {
    /**
     * @ngdoc property
     * @name vm
     * @propertyOf app.mymodule.controller:MyController
     * @description
     * A named variable for the `this` keyword representing the ViewModel
     */
        var vm = this,
      searchText;
    vm.customerService = customerService;
    vm.fetchCollection = fetchCollection;
    vm.deleteCustomer = deleteCustomer;

    initialise();

    function initialise() {
      //logic

    }
    /**
     * @ngdoc
     * @name fetchCollection
     * @methodOf app.mymodule.controller:MyController
     *
     * @description
     * Function to retrieve records from the backend service
     * @example
     * vm.fetchCollection(page, perPage);
     * @param {int} page The number of the page of data to be retrieved
     * @param {int} perPage The number of items per page to be retrieved
     * @returns {object} The response object returned from a httpPromise
     */
    function fetchCollection(page, perPage){
      //logic
    }

    function deleteCustomer(model) {
      //logic
  }
})();

ご覧のとおり、いくつかのプロパティが vm 変数からぶら下がっています。これらは通常、コントローラーで定義された関数への参照です。

上記の ngdocs\jsdocs ドキュメント構文を使用すると、vm プロパティをドキュメント フォルダに出力できますが、vm オブジェクト自体のプロパティをドキュメント化する方法がわかりません。

これを行うための賢明な、または推奨される方法はありますか? vm を完全に文書化せず、それぞれの vm.xxx を個別に文書化することについて疑問に思いましたが、これについてはよくわかりません!

ありがとう