Вопросы по теме 'jsdoc'
Вставить относительную ссылку в reStructuredText
Я документирую библиотеку, в которой есть компонент Python и компонент JavaScript. Общая пользовательская документация и документация API Python находятся в reStructuredText, обработанном с помощью Sphinx. JavaScript API находится в jsdoc и...
7789 просмотров
schedule
11.03.2023
Как множественное наследование JsDoc или миксины?
Как документировать примеси или множественное наследование?
/**
* @class Parent
*/
function Parent() {
}
Parent.prototype.parentTest = 5;
/**
* @class Mixin
*/
function Mixin() {
}
Mixin.prototype.mixinTest = 5;
/**
* @class Child
*...
5732 просмотров
schedule
07.05.2023
Интеграция jslint, jsdoc и rhino для запуска из командной строки?
Я должен протестировать все свои js-файлы через командную строку в среде разработки, прежде чем перейти к производству. Как мне интегрировать эти 3? так что я могу бежать
jslint jsfile.js or jslint jsfile1.js jsfile2.js etc
аналогично jsdoc...
437 просмотров
schedule
13.07.2022
Komodo Edit литерал объекта автозаполнения JS
Проблема в том, что Komodo intelli-sense не видит методы объекта, определенные таким образом:
var App = window.App || {
method: function() {
...
}
}
Введите «Приложение». не дает никакого результата.
Однако определение объекта,...
854 просмотров
schedule
02.01.2023
JSDoc: как документировать литерал объекта параметров для родительского класса?
Я использую базовый «класс» jQuery $.widget() , который предоставляет метод option() . Поскольку этого метода нет в моем коде, у меня нет места для документирования аргумента.
Я пытался поставить jsDoc на поля в литерале опций по умолчанию, но...
14159 просмотров
schedule
04.11.2023
Есть ли парсер JSDoc с открытым исходным кодом, написанный на Javascript?
Я ищу парсер JSDoc, который я могу использовать в своем проекте. Я ищу что-то, где я могу передать комментарий JSDoc и получить структурированное описание того, что означает этот комментарий. Большинство инструментов, которые я видел, способны...
2961 просмотров
schedule
27.04.2022
JSDoc - пометить какой-либо код, чтобы он не анализировался, но сохранить документацию?
Я пытаюсь задокументировать файл Javascript с помощью JSDoc (3) следующим образом:
/** 1 if gnome-bluetooth is available, 0 otherwise
* @type {boolean}
*...
1414 просмотров
schedule
14.06.2022
Как документировать обратные вызовы с помощью JSDoc?
Учитывая функцию Javascript, которая принимает функции обратного вызова в качестве параметров:
var myFunction = function(onSuccess, onFailure) {...}
Как документировать возвращаемый тип onSuccess и аргументы?
9139 просмотров
schedule
24.06.2022
Как добавить и использовать тег в jsdoc?
Я пытаюсь добавить customTag в jsdoc. Я создал файл в каталоге плагинов следующим образом:
метод.js
exports.defineTags = function(dictionary) {
dictionary.defineTag("methodHttp", {
mustHaveValue: true,
canHaveType:...
1924 просмотров
schedule
16.08.2022
Как использовать JSDoc3 для документирования вложенных пространств имен
У меня возникают проблемы с использованием JSDoc3 для документирования кода, структурированного в соответствии с этими строками.
/**
* @namespace MyNamespace.MySubNamespace
*/
(function (MyNamespace) {
MyNamespace.MySubNamespace.Foo = {...
5316 просмотров
schedule
05.05.2022
Понимает ли PHPStorm @constructs или @constructor для JavaScript?
Я немного запутался в том, какой JSDoc описывает функцию конструктора для класса, и понимает ли PHPStorm.
Когда я исследую, какой JSDoc использовать, я постоянно сталкиваюсь с двумя версиями. Есть @constructs и @constructor .
Эти два тега...
505 просмотров
schedule
06.09.2023
Как разместить jsdoc/apidoc на Express.js
Я использую http://apidocjs.com/ для создания общедоступной документации для API Express.js, который я создаю. Мой вопрос: как мне использовать Express.js для маршрутизации и обслуживания документации?
Вот моя настройка сервера Express:
/**...
5655 просмотров
schedule
16.03.2023
UML-диаграмма JSDoc
Вопрос. Я редактирую и использую библиотеку javascript с открытым исходным кодом, в коде которой есть теги JSDoc. Мне было интересно, знает ли кто-нибудь о плагине JSDoc, который позволил бы мне создать диаграмму классов из тегов JSDoc....
5288 просмотров
schedule
01.09.2022
Объявите модуль CommonJs как миксин (JsDoc)
У меня есть несколько автономных модулей, которые просто миксины, используемые классами.
В принципе, мой синтаксис именно такой:
/** @mixin actions/actions */
var actions = module.exports;
/**
* Some method
*/
actions.foo = function () {};...
249 просмотров
schedule
23.01.2024
Документирование возврата конструктора javascript с помощью jsdoc
У меня есть функция javascript, которая возвращает конструктор (см. пример кода ниже). Как бы я задокументировал это с помощью тега @returns jsdoc. Кажется неправильным делать @returns {MyConstructor}, потому что это подразумевает, что я возвращаю...
4893 просмотров
schedule
22.07.2022
Как генерировать комментарии JSDoc для функций, когда комментариев нет?
Я пытаюсь создать плагин для JSDoc. Я слежу за документацией (которой, по иронии судьбы, не хватает) и не знаю, как это сделать.
Мой плагин загружается правильно, и я пробую простой пример. Вот мой плагин (который загружается, потому что я могу...
904 просмотров
schedule
29.05.2023
WebStorm: как создать документацию JSDoc
Я только начал использовать WebStorm и JSDoc для документирования своего JavaScript. Тем не менее я не нашел способа создать документацию в формате HTML, используя какую-то встроенную функциональность WebStorm. Я искал в Интернете и Stack Overflow,...
19990 просмотров
schedule
04.05.2023
JSDOC для классов в Javascript Closure или Anonymous Function
Я хотел добавить аннотации jsdoc к своим кодам AngularJS, поэтому я попытался:
PageFactory.js
/**
* Creates an instance of PageFactory.
*
* @constructor
* @this {PageFactory}
*
*/
function PageFactory() {
}
angular.module ( 'app'...
483 просмотров
schedule
05.10.2022
Как я могу установить версию компонента полимера (wc) на странице API/doc?
Я делаю собственный веб-компонент с использованием полимера, и теперь я пытаюсь написать некоторую документацию, но не могу найти способ изменить/установить версию компонентов. Я использую исходный элемент полимера yoman и основной компонент...
66 просмотров
schedule
25.06.2022
JSDoc - правильный способ создания пользовательского типа в отдельном файле
Я хочу создать собственный тип, например, для завершения кода в отдельном файле с именем custom-types.js , как я нашел в заголовке Репозиторий Rzslider angular , в файле Файл Rzslider.js внизу:
/**
*
* @name Author
* @property {number} id...
503 просмотров
schedule
17.08.2022
