Question

我试图通过 nodejs 来解决 JSDoc 3.5 的问题，并制作了一个小脚本来测试它。我正在使用JSDoc而没有任何更改或自定义配置。

这是脚本：

/**
 * TestLib
 * A simple test for jsdoc to parse
 * @author MMAI
 * @version 0.1
 * @returns {TestLib} The static reference of this lib
 */
 'use strict';
function TestLib() {
    var api = {};

    /**
     * testMethod()
     * adds two arguments together and returns the results
     * @type {Function}
     * @param {Number} a_arg1 The first number in the addition
     * @param {Number} a_arg2 The second number in the addition
     * @returns {Number} The result of the addition
     */
    api.testMethod = function (a_arg1, a_arg2) {
        return a_arg1 + a_arg2;
    };

    //api set
    return api;
}

目前，global.html中仅记录了全局函数 TestLib ，但未记录 testMethod 。这是否意味着JSDoc不能很好地使用这种编码？或者我在这里错过了什么？

提前感谢你能解决这个问题。

吉姆

Answer 1

好的，找到了我需要的东西。我需要在内部方法中使用@namepsace和@alias。

/**
 * @namespace
 * TestLib
 * A simple test for jsdoc to parse
 * @author MMAI
 * @version 0.1
 * @returns {TestLib} The static reference of this lib
 */
 'use strict';
function TestLib() {
    var api = {};

    /**
     * @alias TestLib.testMethod
     * adds two arguments together and returns the results
     * @type {Function}
     * @param {Number} a_arg1 The first number in the addition
     * @param {Number} a_arg2 The second number in the addition
     * @returns {Number} The result of the addition
     */
    api.testMethod = function (a_arg1, a_arg2) {
        return a_arg1 + a_arg2;
    };

    //api set
    return api;
}

JSDoc不会使用这个示例脚本，为什么？

1 个答案: