このコードを考えると:
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
、 の特別なメソッドを文書化したいというもの$resource
です。非標準の方法でに含めるのではなく、標準の jsdoc の方法で (@ngdoc function
特殊@methodOf
関数自体を使用して)実行したいと思います。@description
$resource