J'ai du mal à utiliser JSDoc3 pour documenter le code structuré dans ce sens
/** * @namespace MyNamespace.MySubNamespace */ (function (MyNamespace) { MyNamespace.MySubNamespace.Foo = { doSomething: function (someParam) { // doing it } } })(window.MyNamespace)
Comment utiliser JSDoc3 pour documenter que MyNamespace
contient MySubNamespace
qui contient Foo
? De plus, comment associer doSomething
avec Foo
et documenter son paramètre someParam
?
Une limitation que j'ai, c'est que je ne peux pas ajouter de documentation au fichier dans lequel MyNamespace
et MySubNamespace
sont déclarés.
Merci beaucoup!
Deviner. J'espère que cette solution aide les autres.
/** * @namespace MyNamespace.MySubNamespace */ (function (MyNamespace) { /** * Foo namespace * @namespace Foo * @memberOf MyNamespace.MySubNamespace */ var Foo = { /** * Does something. * @memberOf MyNamespace.MySubNamespace.Foo * @param {object} someParam Some parameter. */ doSomething: function (someParam) { // doing it } }; MyNamespace.MySubNamespace.Foo = Foo; })(window.MyNamespace)