Описание тега jsdoc
JSDoc is a markup language for adding inline API documentation to JavaScript source code. This is distinct from the various tools that parse and manipulate code that follows the JSDoc syntax.
1
ответ
ngdocs - как добавить стили в демонстрационный пример
Я хотел бы добавить свои таблицы стилей CSS в демонстрационные примеры в документации по ngdocs. Я хочу, чтобы стили влияли на саму демонстрацию, но, очевидно, они не должны влиять на всю веб-страницу. Я попытался добавить свою таблицу стилей в пара…
05 ноя '15 в 06:54
2
ответа
JSDoc комментарий складывается в VSCode
Есть ли способ сложить блоки комментариев в стиле JSDoc в VSCode v1.25 для файлов JavaScript? Мне предлагают нормальный свертывание кода, но блоки комментариев кажутся исключенными. Есть ли сочетание клавиш, которое могло бы сворачивать код даже без…
19 июл '18 в 02:23
2
ответа
Что вы называете объектом с функцией (ами) в нем
Что вы называете объектом с функцией в нем. Я документирую некоторые функции, которые возвращают это с помощью jsdoc, и мне сложно придерживаться одного способа передачи этого. Это то, что я возвращаю {fnName: [function]} или же {fnNameA: [function]…
25 июл '15 в 04:46
2
ответа
Требовать JSDoc на все функции с JSCS
Я использую JSCS для обеспечения согласованного стиля кода в одном из моих проектов. Есть ли способ использовать JSCS, чтобы проверить, что каждая функция имеет JSDoc? Что-то, что скажет, что это неверно: var add = function(x, y) { return x + y; }; …
19 мар '15 в 13:09
4
ответа
Google Closure Compiler напечатан на 100%
Как я могу сделать так, чтобы мое приложение было напечатано на 100% относительно компилятора Google Closure? Я уже отметил все с помощью комментариев jsdoc. Можно ли вообще получить 100? Я на 64,6%
19 ноя '10 в 23:33
2
ответа
Как описать параметры передаваемой анонимной функции?
Я хочу описать curVal с JSDoc? Я старался @param как раз перед arrays.every() и внутри анонимного обратного вызова, но это не помогло PhpStorm разрешать методы. /** * @param {Array} curVal */ arrays.every(function (curVal) { /** * @param {Array} cur…
14 июл '17 в 15:50
0
ответов
Как форсировать параметры JSDoc с помощью Eslint
Я бы хотел, чтобы наш линтер работал, когда в JSDoc отсутствуют некоторые параметры в нашем документе JS. Например, я могу заставить JSDoc жаловаться на отсутствующие параметры или возвращать теги, но не для public/private/static/classdesc или функц…
03 июл '18 в 16:20
1
ответ
Атрибут для параметра параметров с JSDoc в WebStorm: "Неразрешенная переменная"
У меня есть функция с комментарием jsdoc, которая напоминает следующее в моем коде: /** * Foo function * @param {Object} [options] * @param {String} [options.foo] */ var foo = function (options) { if (!options) options = {}; var foo = options.foo ||…
27 ноя '13 в 06:12
3
ответа
Допустимые типы параметров jsdoc
Есть ли где-нибудь список допустимых типов тегов param для jsdoc? Например, @param {type} myParam Some parameter description Я знаю, что такие вещи, как number а также String допустимы, но что, если я хочу документально подтвердить, что число являет…
02 янв '13 в 23:07
1
ответ
Включить типы потоков в JSDoc
Я читал некоторые вопросы по github и проектам, построенным поверх Flow, для создания "моста" между Flow и JSDoc или просто для генерации JSDoc из аннотации типов Flow. Никто из них не ответил на эту "простую" потребность, которую я имею:Q: Как вклю…
11 сен '17 в 14:44
2
ответа
Как отделить JSDoc от файла / модуля
Когда я генерирую документы, он помещает всю документацию по функциям в один файл. Кроме вызова JSDoc несколько раз для каждого файла и последующего переименования, есть ли способ разделить документы, используя тег или флаг?
16 мар '17 в 13:52
1
ответ
Как документировать функцию-член из класса отца
Как я документирую функцию члена от класса отца. Есть класс A с функцией-членом Afunc(), и я собираюсь документировать, что класс B расширяет A. Я не перезаписываю Afunc () в B, но мне нужно, чтобы функция Afunc () появилась в моем документе, как мн…
25 ноя '13 в 10:25
1
ответ
Как использовать jsdoc с gulp?
Как я могу создать команду gulp для создания документации с использованием jsdoc? Я не хочу использовать пакет gulp-jsdoc, так как он не поддерживается. И пакет, который я использовал для вызова из командной строки, gulp-shell, находится в черном сп…
12 ноя '15 в 05:12
0
ответов
Как я могу изменить, как VS Code отступать многострочные комментарии?
Когда я автоматически делаю отступ в своем коде в VS Code, многострочные комментарии имеют отступ со звездочками, не выровненными по вертикали. Я хотел бы, чтобы они были приведены в соответствие, чтобы я мог соблюдать jsdoc-format, Как я могу заста…
10 янв '19 в 21:16
0
ответов
Как отключить сортировку в jsdoc?
Как я могу отключить сортировку членов и методов в jsdoc? Я хочу, чтобы они имели тот же вид, что и в файлах
09 фев '16 в 14:45
1
ответ
Как отделить документ API от внутреннего документа функций в JSDOC
У меня есть два файла.js, который представляет один модуль. Этот модуль будет представлять API для использования с другими модулями, поэтому я хочу хорошо документировать этот API. Вот структура файлов и функций: file1.js // Include these functions …
07 фев '16 в 12:37
0
ответов
JSDoc: утверждение Node.js заменяет определение класса
В моем проекте Node.js у меня есть нормальные определения классов, такие как: /** * My awesome class. * @constructor */ var MyClass = function MyClass() {} И в другом файле мне это нужно, как: var MyClass = require('./myclass.js').MyClass; Но иногда…
05 апр '16 в 22:18
0
ответов
JSDoc. Могу ли я поместить описание функций в начале файла?
У меня есть какой-то файл. Это выглядит так: /** * @file Description of this file. */ /** * This is the main function that which starts execution. */ function main() { func1(); func2(); } /** * This function № 1 does something. * * @param {number} a…
03 фев '18 в 09:52
1
ответ
Объявление типа / вывод в Eclipse/JSDT
Я хотел бы указать в Eclipse/JSDT тип переменной экземпляра, как в следующем примере: /** * @constructor */ function A() { /** @type Node */ this.x = document.createElement("p"); } Однако среда IDE не распознает тип x, С другой стороны, декларация в…
23 фев '12 в 11:12
0
ответов
Как документировать ограничения количества параметров в JSDoc?
У меня есть функция, которая принимает число: setValue(newAmount){} значения, которые он может принимать, являются целыми числами от 0 до 100. Есть ли способ определить это в JSDoc? Я делаю свои проверки, чтобы предотвратить ввод неправильных значен…
20 ноя '18 в 07:55