Как называется запись функции в документации?

Question

[Александр Косицын]

В технической документации часто можно встретить описание параметров передаваемых функции в таком виде:
скин ниже:

take.ms/0sO81

Имею ввиду запись вот такого типа:
.on(events, [selector], [data], handler)

Как это называется и как написать похожую? Что за синтаксис?

Answer 1

[Виктор Янышев]

Объект jquery?

Comments

[Александр Косицын]

неа. изменил вопрос может теперь подробнее описал вопрос.

[Виктор Янышев]

Александр Косицын, jsdoc Аля автодокументация

[Александр Косицын]

Виктор Янышев, а откуда берется синтаксис со скобками? как правильно расшифровать такой синтаксис?

[Виктор Янышев]

Александр Косицын, ты сразу не понял про что надо изучить jsdoc, что-бы получить ответ и не задавать нелепые вопросы?
Там написано функция принимает на вход аргументы:
Событие: строка,
Селектор: массив,
Дата:массив,
Обработчик: строка

[Александр Косицын]

Виктор Янышев, скинь ссылку на то где это написано.

[Виктор Янышев]

Александр Косицын, https://yandex.ru/search/touch/?text=jsdoc&&lr=10750

[Александр Косицын]

Виктор Янышев, это я тоже нашел. я имел ввиду в самой документации. описание функции в документации идет вот так:
/**
* Convert a string containing two comma-separated numbers into a point.
* @param {string} str - The string containing two comma-separated numbers.
* @ return {Point} A Point object.
*/
static fromString(str) {
// ...
}

А меня интересует вот такая запись:
.on(events, [selector], [data], handler)

[Александр Косицын]

Виктор Янышев,

Там написано функция принимает на вход аргументы:
Событие: строка,
Селектор: массив,
Дата:массив,
Обработчик: строка

спасибо что расшифровал английский текст.

[Aves]

Александр Косицын, конкретно на этом сайте это сделано вручную, а в jsdoc подобное по идее можно сделать найдя подходящий или написав свой template генератора.

[Александр Косицын]

я не думаю что американские компании пишут свой синтаксис документации без правил оформления. и все по своему пишут.