Question

是否允许在JSDoc注释块中使用选项卡？

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

而不是......

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

Answer 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;
}

因此，即使示例中未指定制表符，它们也能正常工作，您可以随心所欲地使用

是否允许在JSDoc注释块中使用标签？

1 个答案: