javascript - JSDoc 注释 block 中是否允许使用制表符？

Question

JSDoc 注释 block 中是否允许使用制表符？

    /**
     * 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;
}

因此，即使示例中未指定选项卡，它们也可以正常工作，并且您可以自由使用您喜欢的任何内容