如何记录服务属性的属性?

时间:2015-10-27 15:56:29

标签: javascript angularjs documentation jsdoc ngdoc

鉴于此代码:

var zomg = angular.module('zomg', []);

/**
 * @ngdoc object
 * @name zomg.Foo
 * @description
 * # Foo
 */
zomg.factory('Foo', [function () {
  return {
    /**
     * @ngdoc object
     * @name zomg.Foo.bar
     * @propertyOf zomg.Foo
     * @description
     * A property of Foo
     */
    bar: {
      /**
       * @ngdoc object
       * @name zomg.Foo.bar.baz
       * @propertyOf zomg.Foo.bar
       * @description
       * A property of Foo.bar
       */
      baz: 100
    }
  };
}]);

我收到此文档:

image

也就是说,Foo.bar.baz属性不会出现在文档中。它被正确解析 - 因为如果我将@propertyOfzomg.Foo.bar更改为zomg.Foo.doesnotexist之类的内容,则在编译文档时会出错。但结果并没有显示在生成的HTML中。

我应该如何记录嵌套对象?实际用例是我有一个包含$resource的服务,我想记录$resource上的特殊方法。我宁愿以标准的jsdoc方式(@ngdoc function使用特殊功能本身的@methodOf)进行此操作,而不是将其包含在@description的{​​{1}}中一种非标准的方式。

0 个答案:

没有答案