JSDoc 注释块中是否允许使用制表符?
Are tabs allowed in a JSDoc comment block?
是否允许在 JSDoc 注释块中使用制表符?
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
而不是...
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
JSDoc 似乎没有说明选项卡是否工作的规范。但是看看 The JSDoc website,似乎他们所有的例子都不使用制表符。
BUT,我尝试创建 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;
}
因此,即使示例中未指定制表符,它们也可以正常工作,您可以随意使用任何您喜欢的东西
是否允许在 JSDoc 注释块中使用制表符?
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
而不是...
/**
* Some description
*
* @function
* @name someName
* @summary And a summary
*/
JSDoc 似乎没有说明选项卡是否工作的规范。但是看看 The JSDoc website,似乎他们所有的例子都不使用制表符。
BUT,我尝试创建 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;
}
因此,即使示例中未指定制表符,它们也可以正常工作,您可以随意使用任何您喜欢的东西