如何使用 jsdoc-toolkit 记录匿名函数（闭包）

Question

我正在尝试使用 JSDoc-toolkit 记录我的代码。我的代码首先被一个自动执行的匿名函数包装。我到底如何记录这一点？我几乎整天都在这上面。 JS Docs 将无法识别匿名函数闭包内的任何内容，因为它不知道如何处理它。它坏了，我的cmets都没有通过。

我的代码看起来像这样。

/** 
 * @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);
 }());

谢谢！

Answer 1

您不能直接记录嵌套函数。但你可以这样做：

/**
 * @module foobar
 */

/**
* @function
* @author Baa
* @name hello 
* @description Output a greeting
* @param {String} name - The name of the person to say hello
*/
(function hello(name) {
    /**
     * @function
     * @author Baz
     * @inner
     * @private
     * @memberof module:foobar
     * @description Check if the argument is a string (see: {@link module:foobar~hello})
     * @param {String} string - The string
     * @returns {String} Returns true if string is valid, false otherwise
     */ 
    var isString = function checkString(string) { return typeof string === 'string'; };
    if (isString(name))
      console.log('Hello ' + name + '!');
}('Mr. Bubbles'));

这里我将checkString 设置为 private 和 inner 是描述性的（因为无法描述嵌套函数），然后我传入@987654324 @ 记录私有函数。最后，我添加一个指向父函数的链接以供参考。

我认为jsdoc 是不必要的挑剔，需要用更好的东西代替。它是javadoc 的一个端口，所以它有很多与Java 相关但与JS 无关的东西，反之亦然。有一些非常常见的 JS 习惯用法，例如 closures 或 nested functions，很难或不可能记录。

我总是检查我的名称路径并使用--explain 标志进行调试。

Answer 2

您可以像这样将@namespace 与@name 和@lends 一起使用：

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