JSDoc 注釋塊中是否允許使用制表符？

Question

是否允許在 JSDoc 注釋塊中使用選項卡？

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

代替...

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

Answer 1

JSDoc 似乎沒有說明選項卡是否有效的規范。 但是查看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;
}

因此，即使示例中沒有指定選項卡，它們也能正常工作，您可以隨意使用任何您喜歡的東西