JSDOC:如何记录函数的内部变量

Question

有没有办法让 JSDOC 显示函数内部的变量，而无需在函数前使用 @namespace 注释？

我制作了一个小测试对象，但它只会显示最后一个函数的内部变量k，该函数被声明为命名空间。我认为使用 @memberof! 注释和精确的 @name 注释将在下面称为 diff 的第二个方法中显示内部变量。我正在使用选项 --access "all"--explain 在命令上运行 jsdoc3。

这是测试对象的代码:

(function(){
    "use strict";
    /**
     * @namespace
     * @type {{}}
     */
    window.myFunctions = {};
    /**
     * Return the sum
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.sum = function(i, j) {
      /**  @type {number} */
      var k = i + j;
      return k;
    };
    /**
     * Return the difference i - j
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.diff = function(i, j) {
      /**
       * @inner
       * @memberof! window.myFunctions.diff
       * @type {number}
       * @name window.myFunctions.diff~k
       */
      var k = i - j;
      return k;
    };
    /**
     * Return the product
     * @namespace
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.multiply = function(i, j) {
      /** @type {number} */
      var k = i * j;
      return k;
    }
});

Answer 1

我注意到你的代码在 IIFE 中，你应该 read this issue