Блог

Разрешено ли использовать вкладки в блоке комментариев JSDoc?

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

Вместо…

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

Похоже, в 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;
}
  

Итак, исходя из этого, даже если вкладки не указаны в примерах, они будут работать просто отлично, и вы можете использовать все, что вам удобно