Question

我在使用JSDoc3记录按照这些行构建的代码时遇到了麻烦

/**
 * @namespace MyNamespace.MySubNamespace
 */

(function (MyNamespace) {
    MyNamespace.MySubNamespace.Foo = {
        doSomething: function (someParam) {
            // doing it
        }
    }
})(window.MyNamespace)

我如何使用JSDoc3来记录MyNamespace包含MySubNamespace的{{1}}？此外，我如何将Foo与doSomething相关联并记录其参数Foo？

我的限制是我无法在声明someParam和MyNamespace的文件中添加文档。

非常感谢！

Answer 1

想出来。希望这个解决方案可以帮助其他人。

/**
 * @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)

如何使用JSDoc3来记录嵌套的命名空间

1 个答案: