Описание тега jsdoc3
JSDoc3 - это генератор документации API для JavaScript. Его можно настроить с помощью механизма плагинов, а выводом можно управлять с помощью шаблонов. Он написан на Javascript и может работать с Node.js или Rhino.
0
ответов
JSDock - Документация для параметра функции anonymus arrrow
У меня есть функция, которая получает параметр функции стрелки, и мне нужно описать его. /** * Some awesome descriptions * @param {Object} param - param * @param {string} param1 - param1 * @param {function} func - function */ function function(param…
13 фев '17 в 16:08
0
ответов
Как форсировать параметры JSDoc с помощью Eslint
Я бы хотел, чтобы наш линтер работал, когда в JSDoc отсутствуют некоторые параметры в нашем документе JS. Например, я могу заставить JSDoc жаловаться на отсутствующие параметры или возвращать теги, но не для public/private/static/classdesc или функц…
03 июл '18 в 16:20
2
ответа
Как отделить JSDoc от файла / модуля
Когда я генерирую документы, он помещает всю документацию по функциям в один файл. Кроме вызова JSDoc несколько раз для каждого файла и последующего переименования, есть ли способ разделить документы, используя тег или флаг?
16 мар '17 в 13:52
1
ответ
Документирование класса в модуле AMD с помощью JSDoc 3
Я пытаюсь документировать класс в модуле AMD JavaScript с помощью JSDoc 3. Вот мой код, основанный на примере в документации здесь: /** * A module representing a jacket. * @module my/jacket */ define('my/jacket', function() { /** * @class * @alias m…
09 сен '16 в 14:03
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
1
ответ
Как документировать javascript функцию высшего порядка?
У меня есть следующая функция более высокого порядка для обертывания конструкторов: /** * Wrapper for calling constructor with given parameters * * @param {Class} Cls * @returns {function} Wrapper on constructor which creates an instance of given Cl…
11 апр '17 в 03:48
1
ответ
Как правильно определить JSDoc для модулей Node.js в случае расширения / наследования на миксинах
У меня есть три модуля Node.js. Один называется user получает наследство от base модуль. handler Модуль взаимодействует с экземпляром user: Базовый модуль - который становится наследником: /** * Base module */ 'use strict'; const _ = require("unders…
10 апр '17 в 17:08
0
ответов
Как поделиться документацией методов внутри класса с jsdoc?
В моем классе есть методы с одинаковым описанием аргументов. /** * @constructor */ var Person = function (){}; Person.prototype = { /** * @param {!string} [arg] - words */ whisper: function(arg){ console.log(arg.toLowerCase()); }, /** * @param {!str…
26 окт '16 в 21:26
1
ответ
Использование ngdocs со свойствами контроллера в angularJS
Я только начинаю разбираться, используя grunt-ngdocs для моего углового приложения, и пока все хорошо. Но теперь я хотел бы задокументировать некоторые свойства другого задокументированного свойства в одном из моих контроллеров. Рассмотрим следующий…
30 дек '15 в 14:44
0
ответов
NGDOC - нисходящая иерархия
У меня большой проект AngularJS, который задокументирован с помощью NGDOC. У нас много форм, и конкретные директивы могут быть включены только в конкретные формы. Теперь это задокументировано как зависимости - каждая директива имеет @requires my.dir…
02 июл '15 в 12:44
2
ответа
Диаграмма JSDoc UML
Вопрос: я редактирую и использую библиотеку javascript с открытым исходным кодом, в коде которой есть теги JSDoc. Мне было интересно, знает ли кто-нибудь о плагине JSDoc, который позволил бы мне генерировать диаграмму классов из тегов JSDoc. Изменит…
18 дек '13 в 17:40
0
ответов
Как я могу использовать jsdoc с Java?
Как я могу генерировать JSDoc, используя Java. Есть ли лучший подход, чем использование командной строки jsdoc через процесс Java? Я не хочу выполнять команду из Java. Пробовал Nashorn, но он не поддерживает импорт модулей. Попытался Nashorn с jvm-n…
13 авг '18 в 10:49
1
ответ
WebStorm и jsdoc3, определение разрешенных параметров не работает?
Основываясь на документации, реализация JSDoc в WebStorm кажется очень ограниченной. Есть ли способ его продлить? Я не могу найти никаких плагинов. В частности, я бы хотел, чтобы "разрешенные параметры" работали ( как реализовано 2014-04-11)
06 июн '17 в 20:33
0
ответов
JSDocs3: правильно аннотировать закрытие
Большая часть моего опыта работы с JS связана с работой с замыканиями, подобными тем, которые были найдены и поощрены d3.js, как показано в таблицах многократного использования. Так что, если я напишу свое собственное замыкание с его собственными по…
14 май '18 в 12:36
3
ответа
Javascript + JsDoc: Как документировать новые типы данных ES6, такие как карта?
Я пытаюсь использовать JSDoc в своем проекте ES6, я возвращаю карту: /** * Some documentation.. * * @returns {undefined} <- This should be replaced */ function returningMap() { const someMap = new Map(); someMap.set("key", {a, b, c}); return some…
12 июл '16 в 06:41
1
ответ
ngdocs - как документировать конфигурацию модуля и запустить блок
Недавно я начал использовать ngdocs в своем угловом приложении, и я озадачен тем, как правильно задокументировать конфигурацию модулей и запустить блок. У меня есть это в настоящее время: /** * @ngdoc overview * @name app.core * @description * # app…
31 дек '15 в 11:58
5
ответов
Перечислите как тип @param в JSDoc
Можно ли использовать перечисление для JSDoc @param объявление типа, как в следующем примере? /** * @enum { Number } */ var TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ function useTypesEnum( type ) { } Если я использую IDE, напри…
11 фев '14 в 13:00
1
ответ
Тип JSDoc для возвращаемых экземпляров класса
Я использую Node.js с двумя модулями и одним скриптом, который зависит от них: Библиотека / bar.js module.exports = class Bar { // .. }; Библиотека / foo.js const Bar = require('./Bar.js'); module.exports = class Foo { /** * @return {Bar} A Bar inst…
04 авг '17 в 11:40
1
ответ
Массив Jsdoc с несколькими разными элементами в массиве
Я хочу сделать jsdoc что-то вроде следующего /** @param {string|number[]} */ Выше это массив чисел или строка, но я хочу массив чисел и / или строк. Мне нужно, чтобы это работало для других вещей, таких как 2 разных типа объектов. Кто-нибудь знает к…
10 дек '18 в 20:15