我试图用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在这种编码下无法正常工作?还是我在这里想念什么?
在此先感谢您提供的任何信息。
吉姆
最佳答案
好的,找到了我所需要的。我需要在内部方法中使用@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;
}
关于javascript - JSDoc无法使用此示例脚本,为什么?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/47358355/