有没有办法让 JSDOC 显示函数内部的变量而不使用@命名空间函数前面的注释?
我做了一个小测试对象,但它只会显示内部变量k对于最后一个函数,它被声明为命名空间。我想使用@成员!注释和精确@name注释将在下面调用的第二个方法中显示内部变量diff。我正在使用选项在命令上运行 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;
}
});
我注意到你的代码在 IIFE 中,你应该阅读本期 https://github.com/jsdoc3/jsdoc/issues/456
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)