2016-10-01 29 views
1

是否允许在JSDoc注释块中使用选项卡?在JSDoc注释块中是否允许制表符?

/** 
    * Some description 
    * 
    * @function 
    * @name   someName 
    * @summary   And a summary 
    */ 

而不是...

/** 
    * Some description 
    * 
    * @function 
    * @name someName 
    * @summary And a summary 
    */ 

回答

1

看来JSDoc不具有规定的标签是否工作或不规范。但看看The JSDoc website,看起来他们所有的例子都不使用制表符。

但是,我试着创建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; 
} 

所以要通过这个,即使在例子中没有指定标签,他们将工作得很好,你可以自由地使用任何你是舒服

相关问题