Javascript-форум - Вопросы по JSDoc

Javascript-форум (https://javascript.ru/forum/)

- Оффтопик (https://javascript.ru/forum/offtopic/)

- - Вопросы по JSDoc (https://javascript.ru/forum/offtopic/40520-voprosy-po-jsdoc.html)

Блин, фигня. Выбрал для вывода haruki (такой темплейт, который выводит доку в JSON или XML), массив examples остался пустым. Значит, я где-то с синтаксисом налажал.

FINoM,
Если ты поднавтыкался уже, скинь пож-та пару примеров как аннотации писать в разных случаях. Мне тоже сейчас понадобилось неожиданно.

Tim, пока ничего не делал, но можно глянуть на мои вопросы на хабре: http://habrahabr.ru/users/finom/qa/questions/ (первые две штуки)

FINoM,
Спс, пригодится.

Вот кст нашёл. На старой работе был семинар по этой теме PHPDoc, JSDoc.docx

Там пара интересных моментов про документирование jQuery плагинов

Как в jsdocs сказать "второй и последующие параметры могут иметь произвольный тип"? Минимальное кол-во параметров - 1.

Цитата:

Сообщение от nerv_

Решил гуглнуть ради интереса. Вот что получилось:

Цитата:

Allows a parameter to be repeated

/**
 * Returns the sum of all numbers passed to the function.
 * @param {...number} num - A positive or negative number.
 */
function sum(num) {
    var i = 0, n = arguments.length, t = 0;
    for (; i < n; i++) {
        t += arguments[i];
    }
    return t;
}

пруф

Т.е. {...number} эта запись означает что параметр может повторяться. Произвольный тип это - *. + нужно сделать его не обязательным: {...*} [bar]. Т.е. что то такое:

@param {boolean} foo First parameter
@param {...*} [bar] Second parameter

Первый обязательный а второй нет и может повторяться. Думаю как то так, но не проверял.

Tim, спасибо (карму не плюсует). Только, наверно, так:

Цитата:

Сообщение от Tim

// @param {...*} [bar] Second parameter

// @param {...*} [...] Second parameter

хотя, нет :)

Цитата:

Сообщение от nerv_

карму не плюсует

Тогда верни мне мои 15 минут жизни бездарно потраченные на гугленье этой фигни :D

Цитата:

Сообщение от nerv_ (Сообщение 275166)

Tim, спасибо (карму не плюсует). Только, наверно, так:

// @param {...*} [...] Second parameter

Смотря зачем ты пишешь jsdoc. Если для GCC, то

/**
 * @param {...*} foo
 */

А если для докогенератора, то нужно смотреть его синтаксис.
Я юзаю гугловский стандарт JSDoc (он немного отличается), а для генерации доки написал свой движок.

Ман по стандарту гугла
https://developers.google.com/closur...s-for-compiler

kobezzza, спс

Цитата:

Сообщение от Tim

Тогда верни мне мои 15 минут жизни бездарно потраченные на гугленье этой фигни

фсе претензии к владельцу ресурса :)