Wie kann ich die Methoden eines verschachtelten Objekts mit JSDoc dokumentieren?
Ich habe versucht, mithilfe von JSDoc3 eine Dokumentation für eine Datei zu erstellen, habe jedoch einige Probleme. Die Datei (die ein Require.js-Modul ist) sieht im Grunde so aus:
define([], function() {
/*
* @exports mystuff/foo
*/
var foo = {
/**
* @member
*/
bar: {
/**
* @method
*/
baz: function() { /*...*/ }
}
};
return foo;
}
Das Problem ist, ich kann nicht bekommenbaz
in der generierten Dokumentation auftauchen. Stattdessen bekomme ich nur eine Dokumentationsdatei für einefoo/foo
Modul, in dem abar
Mitglied, aberbar
hat keinbaz
(nur ein Link zufoo
Quellcode).
Ich habe versucht, mich umzuziehenbar
die richtlinie zu@property
Stattdessen habe ich versucht, mich zu ändernbaz
die richtlinie zu@member
oder@property
, aber nichts davon hilft. Egal was ich tue, Baz scheint einfach nicht auftauchen zu wollen.
Weiß jemand, welche Direktivenstruktur ich verwenden könnte, um baz in der generierten Dokumentation erscheinen zu lassen?
P.S. Ich habe versucht, Seiten wie diese auf der JSDoc-Site zu lesenhttp://usejsdoc.org/howto-commonjs-modules.html, aber es beschreibt nur Fälle vonfoo.bar
nichtfoo.bar.baz
.