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

【问题标题】：How to use JSDoc3 to document nested namespaces如何使用 JSDoc3 记录嵌套的命名空间
【发布时间】：2013-06-15 09:20:58
【问题描述】：

我在使用 JSDoc3 来记录按照这些思路构建的代码时遇到了问题

/**
 * @namespace MyNamespace.MySubNamespace
 */

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

我将如何使用 JSDoc3 来记录 MyNamespace 包含 MySubNamespace 而其中包含 Foo？此外，我如何将doSomething 与Foo 关联并记录其参数someParam？

我的一个限制是我无法将文档添加到声明 MyNamespace 和 MySubNamespace 的文件中。

非常感谢！

【问题讨论】：

标签： javascript namespaces documentation jsdoc

【解决方案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)

【讨论】：