3
ответа
JSDoc добавление реального кода в документации
Вы знаете, существует ли своего рода <код/> тег в JSDoc? Я должен добавить части кода в моей документации как это: / ** * Эта функция делает что-то видит пример ниже: * * var x = нечто ("...
вопрос задан: 13 May 2018 09:32
3
ответа
Лучший способ зарегистрировать анонимные объекты и функции с [закрытым] jsdoc
Править: Это - технически 2 вопроса о части. Я выбрал лучший ответ, который касается вопроса в целом и связанный с ответом, который обрабатывает конкретный вопрос. К чему лучший способ...
вопрос задан: 13 January 2016 10:30
1
ответ
Есть ли способ указать экспорт подстановочных знаков в JSdoc?
В моем проекте модели базы данных динамически загружаются и экспортируются из папки моделей. Я хочу указать в JSdoc, что любое свойство module.exports является типом Sequelize ....
вопрос задан: 29 March 2019 06:43
1
ответ
Как зарегистрировать обработчик событий в JSDoc? [закрытый]
Предположим, что у меня есть класс как это: функционируйте myClass (q) {this.someFunction = функция (e) {console.log ("Нажимают событие");}; jQuery (q) .click (this.someFunction);} там способ указать...
вопрос задан: 1 March 2019 00:35
1
ответ
Как документировать файлы модульного теста javascript с помощью jsdoc?
У меня есть реактивный проект, и я использую Jest для написания модульных и интеграционных тестов. Я хочу использовать jsdoc для документирования этих файлов. Но не знаете как? не нашел ничего на странице jsdoc. Может кто-нибудь ...
вопрос задан: 18 January 2019 12:06
1
ответ
JSDoc, документирование словаря с записями по умолчанию
В машинописном тексте я могу задокументировать словарь / карту, в которой есть определенные заданные записи, но все же это словарь / карта (как вы можете добавлять или удалять записи), как этот тип Foo = {bar: number; му: номер; ...
вопрос задан: 18 January 2019 02:40
1
ответ
Как правильно написать многострочный код в комментарии JSDoc в проекте javascript / typcript в VSCode?
При работе над проектом javascript / typcript в VSCode я хочу написать многострочный код в комментарии. Зная, что VSCode поддерживает синтаксис уценки в комментариях, я продолжаю и пишу: / ** * `` `ts * {...
вопрос задан: 17 January 2019 02:09
0
ответов
JSDoc: Typedef из буквального
Давайте рассмотрим следующий код, функцию, которая возвращает объект с двумя функциями: / ** * Создать что-то * @returns {object} Something * / function createSomething () {return {/ ** ...
вопрос задан: 20 March 2019 13:24
0
ответов
Перегруженная функция JSDoc не работает с TypeScript
Я использую синтаксис перегрузки JSDoc, как предложено в других вопросах и в Интернете, не уверен, правильно ли он у меня, но здесь идет речь: / ** * @param {string} param * @returns {'string result'} * // * * * @ ...
вопрос задан: 21 February 2019 20:37
0
ответов
Ошибка TypeScript FileReader для window.FileReader?
У меня есть файл кода JavasScript для чтения файла в браузере. Я добавил проверку TypseScript в файл. Теперь он дает сообщение об ошибке. [ts] Свойство 'FilesReader' не существует для типа '...
вопрос задан: 19 January 2019 11:07
0
ответов
документирование неизвестных дополнительных необязательных свойств в JSDoc
У меня есть функция, которая принимает один аргумент объекта. Важное значение имеет одно конкретное свойство этого объекта, а все остальные потенциальные свойства будут игнорироваться. Как я могу документировать дополнительные ...
вопрос задан: 31 December 2018 15:46
0
ответов
Правильный способ документирования функций с открытым аргументом в JSDoc
Давайте скажем, у вас есть что-то вроде следующего: var someFunc = function () {// здесь что-то делаем с аргументами
} Как бы вы правильно задокументировали, что эта функция может принимать любое количество ...
вопрос задан: 23 May 2017 12:34
0
ответов
Как задокументировать список аргументов с помощью переменная длина с известными типами параметров?
По теме: Правильный способ документирования функций с открытыми аргументами в JSDoc У меня есть функция, которая принимает несколько массивов путем доступа к переменной аргументов: / ** * @param options Объект, содержащий. ..
вопрос задан: 23 May 2017 12:10
0
ответов
Генератор документации JavaScript, совместимый с jQuery
Мне нужно выбрать генератор документации (аналогичный jdoc в java или rdoc в ruby) для моего проекта javascript, который (построен с помощью jquery, подчеркивания и основы) Кандидаты: jsdoc toolkit
pdoc
...
вопрос задан: 23 May 2017 12:09
0
ответов
Существует ли стандарт JSDoc?
Я знаю, что есть разные варианты JSDoc. И кажется, что каждая реализация парсера JSDoc распознает свой собственный набор тегов. Например, рассмотрим различия в тегах между http:/...
вопрос задан: 23 May 2017 10:30
0
ответов
Как документировать разрешенные значения обещаний JavaScript
Учитывая этот код: function asyncFoo () {вернуть новое Promise (function (execute, reject) {doAsyncStuff (function (err, data) {if (err) reject (new Error (err))); иначе выполнить (new Bar (data) ...
вопрос задан: 19 May 2017 04:43
0
ответов
Создание организации, подобной пространству имен, в библиотеке сценариев приложений Google.
Я пытался создать набор инструментов с использованием сценария приложений Google. Проблема в том, что, насколько я могу судить, допускается только один уровень организации. Вы можете создать библиотеку под названием «Секундомер»…
вопрос задан: 14 May 2017 20:46
0
ответов
Как я могу сгенерировать документацию по JavaScript API для GitHub Pages [закрыто]
Существует множество отличных возможностей для создания документации API для других языков, но мне еще предстоит найти решение для моего JavaScript API, которое я хочу разместить на GitHub Pages. Кажется, что я могу ...
вопрос задан: 7 April 2016 03:13
0
ответов
JSDoc: Как документировать литерал объекта «options» для родительского «класса»? [дубликат]
Я использую базовый «класс» jQuery $.widget(), который предоставляет метод option(). Поскольку этого метода нет в моем коде, у меня нет места для документирования аргумента. Пробовал ставить jsDoc на поля в...
вопрос задан: 26 February 2016 13:20
0
ответов
Как документировать свойства объекта в теге JSDoc 3 :@this
Тег @param позволяет документировать свойства, например. /***@param {Object} userInfo Информация о пользователе. *@param {String} userInfo.name Имя пользователя. *@param {String}...
вопрос задан: 15 October 2015 15:51
0
ответов
Документировать возвращаемое значение и параметр коллекции (массива типа) в JSDoc
Как документировать возвращаемое значение (и параметры) массива в JSDoc, когда элементы массива могут быть одним из следующих: Тип (например, String, Array).
Объектный литерал.
вопрос задан: 21 August 2015 12:08
0
ответов
JSDocs: документирование экспресс-маршрутов Node.js
Я пытаюсь документировать вызовы router.get с помощью JSDocs. Я не могу заставить документацию правильно отображаться на странице, если я пытаюсь добавить ее к самому вызову маршрутизатора. /** * Проверка здоровья * @...
вопрос задан: 4 August 2015 20:18
0
ответов
JSDoc определяет функцию только в документах
Я использую IDE, я хочу автозаполнение некоторой функции, но функция не определена в коде, тогда у меня есть предупреждение. например у меня есть объект var client = getRemoteClien (); // здесь ...
вопрос задан: 25 February 2015 13:35
0
ответов
Как документировать исходный код CoffeeScript с помощью JSDoc?
У меня есть некоторый код, написанный на CoffeeScript, и я хочу оптимизировать сгенерированный JavaScript с помощью компилятора Google Closure, поэтому эти файлы необходимо документировать с помощью JSDoc. У меня вопрос, как я могу ...
вопрос задан: 13 May 2014 22:46
0
ответов
Как я могу просмотреть схему в eclipse при использовании шаблона раскрывающегося модуля?
В настоящее время я рефакторинг некоторого кода Javascript, который у нас есть, и среди прочего я изменил его, чтобы сделать использование шаблона раскрывающегося модуля. Код выглядит намного аккуратнее, и он работает нормально, но я могу'...
вопрос задан: 30 April 2014 11:48
0
ответов
Как jsdoc указывает, что @param является MouseEvent?
Как jsdoc указывает, что @param является MouseEvent? HTMLElement DIV? / ** * @param {MouseEvent} e * / window.clickToButton = function (e) {console.dir (e); } / ** * @param {...
вопрос задан: 9 August 2013 06:22
0
ответов
Как документировать модуль Require.js (AMD) с помощью jsdoc 3 или jsdoc?
У меня есть 2 типа модулей: Основной файл Require.js: require.config({ baseUrl: "/another/path", paths: { "some": "some/v1.0" }, waitSeconds: 15, локаль: "fr-fr"
...
вопрос задан: 8 August 2013 14:59
0
ответов
допустимые типы параметров jsdoc
Есть ли где-нибудь список допустимых типов тегов param для jsdoc? Например, @param {type} myParam Некоторое описание параметра Я знаю, что такие вещи, как число и строка действительны, но что если я ...
вопрос задан: 2 January 2013 23:07
0
ответов
Как документировать обратные вызовы с использованием JSDoc?
Учитывая функцию Javascript, которая принимает функции обратного вызова в качестве параметров: var myFunction = function (onSuccess, onFailure) {...} Как мне документировать тип и аргументы возвращаемого значения в onSuccess?
вопрос задан: 15 November 2012 19:01
0
ответов
Как документировать генератор функций с помощью jsdoc?
Я пытаюсь задокументировать генератор функций, но безуспешно, это пример :function genericObjectGenerator (tagname ){ var SpecificObject = function (){}; специфическийОбъект.getClassName =...
вопрос задан: 15 August 2012 18:46