web-dev-qa-db-ja.com

jsdoc-toolkitを使用して無名関数（クロージャ）を文書化する方法

JSDoc-toolkitを使用してコードを文書化しようとしています。私のコードは、自己実行型の無名関数でラップされることから始まります。これをどのように文書化するのですか？私はこれにほぼ一日を費やしました。 JS Docsは、匿名関数クロージャをどう処理するかわからないため、匿名関数クロージャ内の何も認識しません。それは壊れて、私のコメントは何も届きません。

私のコードは次のようになります。

/** 
 * @fileoverview BLA BLA BLA
 */

/**
 * This is where I don't know what to put.
 */
 (function () {
     "use strict";

     /** or here */
     var stlib = function (param, param, param) {
         /** or here */
         var share = {
             /** or here */
             config: {
                 button: DOM Element,
                 property: blablabla
             },

             init: function () { ...some init code here}
         };

         share.init();
     };

     widgets.add("share", stlib);
 }());

ありがとうございました！

javascriptcommentsclosuresanonymous-functionjsdoc
33
Jesse Atkinson

@namespaceを@nameおよび@lendsとともに次のように使用できます。

/**
* @name MyNamespace
* @namespace Hold all functionality
*/
(function () {
    "use strict";
    /** @lends MyNamespace*/
    var stlib = function (param, param, param) { ...All of my code...};
}());
3
Microfed