如何告诉JSDoc我将命名空间对象作为参数传递？

Question

I'm using an anonymous function to add methods to a namespace object. In the end, I would want JSDoc (version 3.3) to generate documentation for MyNamespace.func1() , MyNamespace.func2() , etc. I guess I could add this information to each of the methods defined in the function, but it would be a lot easier to have JSDoc3 recognize that ns is the same as MyNamespace . How do I do that?

/** @namespace */
var MyNamespace = {};

// (... some code that adds to MyNamespace ...)

(function (ns) {

    /** Method description 1 */
    ns.func1 = function (val) {};

    /** Method description 2 */
    ns.func2 = function (val) {};

    // ...etc

})(MyNamespace);

Answer 1

您可以在JSDoc文档中看到有关别名的类似情况的示例，请参见“为命名空间的静态成员使用@alias”一节。

Answer 2

Apparently, this is not possible with JSDoc 3 (yet).

I ended up using a merge/extend/augment-type helper function, like this:

(function (ns) {

    extend(ns, /** @lends ns */ {

        /** Method description 1 */
        func1: function (val) {},

        /** Method description 2 */
        func2: function (val) {},

        // ...etc
    });

})(MyNamespace);

This gives JSDoc everything it needs to create the proper documentation. One minor disadvantage is that func1 will now show up as extend.func1 in the Chrome error console stack trace.