2013-06-15 17 views
6
私はJSDoc3が

どのようにネストされた名前空間

/** 
* @namespace MyNamespace.MySubNamespace 
*/ 

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

がどのように私はMyNamespaceFooが含まれているMySubNamespaceが含まれていることを文書化するJSDoc3を使用することになり、これらの線に沿って構造のコードを文書化するために使用してトラブルを抱えている

を文書化するJSDoc3を使用するには?さらに、doSomethingFooに関連付け、そのパラメータsomeParamを文書化するにはどうすればよいですか?

制限があるのは、MyNamespaceMySubNamespaceが宣言されているファイルにドキュメントを追加できないということです。

ありがとうございます!

答えて

17

このソリューションが他の人に役立つことを望みます。

/** 
* @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)  
関連する問題