Javascript JSDoc注释块中是否允许使用选项卡?
允许在JSDoc注释块中使用选项卡吗Javascript JSDoc注释块中是否允许使用选项卡?,javascript,jsdoc,Javascript,Jsdoc,允许在JSDoc注释块中使用选项卡吗 /** * Some description * * @function * @name someName * @summary And a summary */ 而不是 /** * Some description * * @function * @name someName * @summa
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
而不是
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
JSDoc似乎没有一个说明选项卡是否工作的规范。但是看看,他们所有的例子似乎都不使用标签 但是,我尝试创建了3个函数——1个在文档中有选项卡,1个在文档中有长的选项卡间距,1个没有选项卡,并在它们上使用JSDoc文档生成器,它似乎工作得很好 我使用的测试函数:
/**
* This function receives 3 variables and returns their sum
* @param {int} myvar - A number
* @param {int} myvara - A number
* @param {int} myvarb - A number
* @return {int} The sum of all numbers
*/
function testwithtabs(myvar, myvara, myvarb) {
return myvar+myvara+myvarb;
}
/**
* This function receives 3 variables and returns their sum
* @param {int} myvar - A number
* @param {int} myvara - A number
* @param {int} myvarb - A number
* @return {int} The sum of all numbers
*/
function testwithlargetabs(myvar, myvara, myvarb) {
return myvar+myvara+myvarb;
}
/**
* This function receives 3 variables and returns their sum
* @param {int} myvar - A number
* @param {int} myvara - A number
* @param {int} myvarb - A number
* @return {int} The sum of all numbers
*/
function testnotabs(myvar, myvara, myvarb) {
return myvar+myvara+myvarb;
}
因此,即使示例中没有指定选项卡,它们也可以正常工作,您可以随意使用任何您喜欢的选项卡