鉴于此代码:
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
}
};
}]);
我得到这个文件:
也就是说,该Foo.bar.baz
属性不会出现在文档中。它被正确解析 - 因为如果我从 更改@propertyOf
为zomg.Foo.bar
类似zomg.Foo.doesnotexist
的内容,编译文档时会出现错误。但结果不会显示在生成的 HTML 中。
我应该如何记录嵌套对象?实际用例是我有一个包含$resource
s 的服务,我想在$resource
. 我宁愿以标准的 jsdoc 方式(@ngdoc function
带有@methodOf
特殊功能本身)而不是以非标准方式将其包含在 jsdoc@description
中$resource
。