Javascript документация входных данных

@GooG2e · Регистрация: 13.06.2011

Студворк — интернет-сервис помощи студентам

Всем привет)
На работе поставили задание - нужно задокументировать формат входных данных для функции Javascript.
Можете подсказать где про это почитать?

@kalabuni · 06.03.2014, 00:14

при вызове функции ей можно передать данные, которые та будет использовать

чаще всего в определении функции её аргументы указаны
function functionName (arg1, arg2, arg3) {...}

функция ждёт какие-то конкретные типы значений для каждого из аргументов
при этом чаще всего существуют какие-то ограничения для каждого аргумента

например, arg1
описание: возраст человека в годах
формат: type Number, целое
ограничение: только положительное число, с каким-то даже верхним пределом (если кто-то напишет возраст в 200 лет, то никто же не поверит)
пример: 12

для arg2, например
описание: цвет глаз человека
формат: type String, стандартная HEX-запись из 4-х или 7-ми символов вместе с впереди идущим символом #
ограничение: вроде нет (хотя если кто-то укажет оранжевый цвет для глаз - опять никто не поверит)
примеры: #12defa или #fff
------

почитайте, например, документацию любого JQuery-метода здесь - это же тоже функции Javascript'a с какими-то требуемыми аргументами

@GooG2e · 06.03.2014, 00:17 **[ТС]**

А в коде это пишется также? просто в комментах?
Это пишется перед каждой функцией или суммарно на все функции?

@Padimanskas · 06.03.2014, 01:59

GooG2e, http://ru.wikipedia.org/wiki/JSDoc

@GooG2e · 06.03.2014, 23:14 **[ТС]**

Спасибо)
В PHPStorm неправильную комбинацию жал и поэтому коммент нужный не вылазил и думал, что тут такого нет)

Новые блоги и статьи Все статьи Все блоги /
Установка Qt Creator для C и C++: ставим среду, CMake и MinGW без фреймворка Qt 8Observer8 05.04.2026 Среду разработки Qt Creator можно установить без фреймворка Qt. Есть отдельный репозиторий для этой среды: https:/ / github. com/ qt-creator/ qt-creator, где можно скачать установщик, на вкладке Releases:. . .	AkelPad-скрипты, структуры, и немного лирики.. testuser2 05.04.2026 Такая программа, как AkelPad существует уже давно, и также давно существуют скрипты под нее. Тем не менее, прога живет, периодически что-то не спеша дополняется, улучшается. Что меня в первую очередь. . .	Отображение реквизитов в документе по условию и контроль их заполнения Maks 04.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа "ПланированиеСпецтехники", разработанного в конфигурации КА2. Данный документ берёт данные из другого нетипового документа. . .	Фото всей Земли с борта корабля Orion миссии Artemis II kumehtar 04.04.2026 Это первое подобное фото сделанное человеком за 50 лет. Снимок называют новым вариантом легендарной фотографии «The Blue Marble» 1972 года, сделанной с борта корабля «Аполлон-17». Новое фото. . .
Вывод диалогового окна перед закрытием, если документ не проведён Maks 04.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа "СписаниеМатериалов", разработанного в конфигурации КА2. Задача: реализовать программный контроль на предмет проведения документа. . .	Программный контроль заполнения реквизитов табличной части документа Maks 02.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа "СписаниеМатериалов", разработанного в конфигурации КА2. Задача: 1. Реализовать контроль заполнения реквизита. . .	wmic не является внутренней или внешней командой Maks 02.04.2026 Решение: DISM / Online / Add-Capability / CapabilityName:WMIC~~~~ Отсюда: https:/ / winitpro. ru/ index. php/ 2025/ 02/ 14/ komanda-wmic-ne-naydena/	Программная установка даты и запрет ее изменения Maks 02.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа "СписаниеМатериалов", разработанного в конфигурации КА2. Задача: при создании документов установить период списания автоматически. . .

@GooG2e 0 / 0 / 0 Регистрация: 13.06.2011 Сообщений: 41

	Javascript документация входных данных 05.03.2014, 23:39. Показов 1804. Ответов 4 Метки нет (Все метки) Всем привет) На работе поставили задание - нужно задокументировать формат входных данных для функции Javascript. Можете подсказать где про это почитать? 0

@kalabuni супермизантроп 3941 / 2979 / 692 Регистрация: 18.04.2012 Сообщений: 8,629
	06.03.2014, 00:14
	при вызове функции ей можно передать данные, которые та будет использовать чаще всего в определении функции её аргументы указаны function functionName (arg1, arg2, arg3) {...} функция ждёт какие-то конкретные типы значений для каждого из аргументов при этом чаще всего существуют какие-то ограничения для каждого аргумента например, arg1 описание: возраст человека в годах формат: type Number, целое ограничение: только положительное число, с каким-то даже верхним пределом (если кто-то напишет возраст в 200 лет, то никто же не поверит) пример: 12 для arg2, например описание: цвет глаз человека формат: type String, стандартная HEX-запись из 4-х или 7-ми символов вместе с впереди идущим символом # ограничение: вроде нет (хотя если кто-то укажет оранжевый цвет для глаз - опять никто не поверит) примеры: #12defa или #fff ------ почитайте, например, документацию любого JQuery-метода здесь - это же тоже функции Javascript'a с какими-то требуемыми аргументами 1

@GooG2e 0 / 0 / 0 Регистрация: 13.06.2011 Сообщений: 41
	06.03.2014, 00:17 [ТС]
	А в коде это пишется также? просто в комментах? Это пишется перед каждой функцией или суммарно на все функции? 0

@Padimanskas Superposition 950 / 615 / 256 Регистрация: 27.10.2013 Сообщений: 2,083
	06.03.2014, 01:59
	GooG2e, http://ru.wikipedia.org/wiki/JSDoc 1

@GooG2e 0 / 0 / 0 Регистрация: 13.06.2011 Сообщений: 41
	06.03.2014, 23:14 [ТС]
	Спасибо) В PHPStorm неправильную комбинацию жал и поэтому коммент нужный не вылазил и думал, что тут такого нет) 0