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

Jul*_* A. 8 javascript documentation namespaces jsdoc

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

/**
 * @namespace MyNamespace.MySubNamespace
 */

(function (MyNamespace) {
    MyNamespace.MySubNamespace.Foo = {
        doSomething: function (someParam) {
            // doing it
        }
    }
})(window.MyNamespace)
Run Code Online (Sandbox Code Playgroud)

我如何使用JSDoc3来记录MyNamespace包含MySubNamespace哪些内容Foo?而且我将如何关联doSomething与Foo和记录它的参数someParam?

一个限制我的是,我不能添加到文档中的文件MyNamespace和MySubNamespace声明.

非常感谢!

Jul*_* A. 22

弄清楚了.希望这个解决方案有助于其

/**
 * @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)    
Run Code Online (Sandbox Code Playgroud)

  • 当尝试将模块添加到命名空间时,这仍然有帮助(在 2022 年) (2认同)