Вопросы по JSDoc

[Vantedur]

Я чуствую что единственный действенный способ документирования кода это создание сайта аналогичного сайту jquery, все остальные подхоты в конце концов или растают или сгнеют

[nerv_]

Всем привет

Подскажите, как написать доку к функции, которая вызывается с одним аргументом, но этот аргумент переменного типа:

1.

/**
* @param {String} id
*/
function Foo( id ) { /* ... */ }

2.

/**
* @param {HTMLDivElement} div
*/
function Foo( div ) { /* ... */ }

[kobezzza]

nerv, в синтаксисе гугла так:

/**
* @param {(HTMLDivElement|string)} divOrId 
*/
function Foo( divOrId ) { /* ... */ }

Если типов много, то с помощью typedef директивы можно создать псевдоним. Также можно использовать: * - любой тип или ? - тип неизвестен

[nerv_]

kobezzza, спасибо

[Antonius]

Думал создавать отдельную тему, но тут обсуждается как раз то, что надо

Поэтому я к вам.

Есть структура данных (объект), классический пример — координаты. В скрипте во многих местах функции принимают в качестве аргумента или возвращают объекты этого формата. При том, что это просто структура — не имеет конструктора, в чистом виде нигде не встречается.

Хочется где-то описать ее, например «coordObject — это объект, содержащий поля x (вещественное число) и y (вещественное число), необязательное поле z (вещественное число) используется для описания трехмерных координат». Затем при описании параметров или возвращаемых значений хочется просто делать ссылку на описание этого формата.

Спасибо. Если это есть в документации, а я не нашел, не увидел или не понял, что это — оно, киньте в меня соответствующей ссылкой, пожалуйста.

[Antonius]

Стоило только спросить — нашел.

http://usejsdoc.org/tags-typedef.html

Вопрос снят, всем спасибо.