10

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

/**
 * @namespace MyNamespace.MySubNamespace
 */

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

我将如何使用 JSDoc3 来记录MyNamespace包含MySubNamespacewhich contains的文件Foo?进一步我将如何关联doSomethingFoo记录它的参数someParam

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

非常感谢!

4

1 回答 1

25

弄清楚了。希望此解决方案对其他人有所帮助。

/**
 * @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)    
于 2013-06-15T01:00:13.627 回答