Вопросы по теме 'jsdoc3'
Проблема jsdoc: отображается полный путь к исходному файлу (нежелательно)
Я использую jsdoc3 для своего проекта, и все прекрасно компилируется.
Но с этим я возился последние 2 дня и сдаюсь :(
При использовании самого простого вызова терминала MacOsX для запуска jsdoc я ВСЕГДА получаю полный путь к моему исходному...
795 просмотров
schedule
29.05.2023
Документирование свойства и метода прототипа с помощью JSDoc-3.3.0-alpha5
У меня есть класс с именем FileDownloader , и я пытался его задокументировать, но свойства и метод, объявленные с использованием prototype , не генерируются в выходном файле.
Как указано в заголовке, я использую jsdoc 3.3.0-alpha5.
Вот код:...
1449 просмотров
schedule
02.03.2024
JSDoc на Nodejs дает TypeError: undefined не является функцией
Я хотел бы создать автоматическую документацию для моего проекта javascript, используя JSDoc, работающий на Nodejs. Я сделал следующее:
Установлен Nodejs
Установил jsdoc из nodejs следующим образом: npm install jsdoc
Казалось, все идет...
533 просмотров
schedule
20.08.2023
@type для экспортированных модулей из node.js и хорошее описание документации?
Я пытаюсь быть хорошим гражданином и документировать свои модули узлов .... но я не уверен, что добавить в @type. Я использую webstorm, поэтому он автоматически помещает @type {exports}, но я немного запутался, что я должен туда поместить?...
2975 просмотров
schedule
11.02.2023
Дополнительные параметры промежуточной функции документа
Существует ли правильный синтаксис для документирования необязательных параметров JavaScript, где необязательный параметр находится в середине заголовка функции (например, jQuery, Gulp и т. д.)
Я задокументировал функцию стандартным способом, и она...
414 просмотров
schedule
31.08.2022
JSDoc: Какая связь между модулями и пространствами имен
Столкнулся с проблемой понимания назначения пространств имён и модулей в союзе. Например, у меня есть класс Game.utils.Matrix . Я хочу аннотировать Game как пространство имен, utils как модуль и Matrix как класс:
/**
* @namespace Game...
3634 просмотров
schedule
15.05.2023
Как задокументировать функцию, возвращаемую функцией, с помощью JSDoc
Я использую JSDoc для документации параметров.
Понятно, как документировать типы параметров для many_prompts , но как правильно документировать возвращаемую функцию?
/**
* @param {Number} - number of times to prompt
* @return...
19477 просмотров
schedule
15.08.2023
расширение jsDoc для обработки пользовательских тегов
Я хочу расширить jsdoc (особенно с помощью docstrap). У меня есть приложение nodeJS, и я хочу разделить навигацию jsdoc на контроллеры, представления и т. Д. Мне удалось в определенной степени с этим справиться, создав свои собственные теги, такие...
312 просмотров
schedule
14.04.2022
Как добавить теги в JSDoc?
Я использую Meteor, у которого есть некоторые странные оговорки по сравнению с обычным JavaScript. Я хочу добавить несколько тегов, чтобы сделать документацию более понятной.
Meteor.methods({
/**
* Upgrade a user's role
*
* @where...
1166 просмотров
schedule
18.12.2022
jsdoc с узлом генерирует пустой index.html
Я использовал следующую команду для создания html из файла javascript.
$> jsdoc --debug jquery.js
$> open out/index.html
Вывод команды
DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT)
DEBUG: Environment info:...
2580 просмотров
schedule
22.07.2022
JSDoc 3.3.3 Неожиданный токен ILLEGAL на отметке в строке шаблона ES6
В терминале я запускаю следующие команды:
$ node sample.js
hello, Stephen MC
$ node_modules/.bin/jsdoc --version
JSDoc 3.3.3 (Tue, 22 Sep 2015 23:14:17 GMT)
$ node_modules/.bin/jsdoc -c jsdocConf.json
Parsing /**/sample.js ...ERROR: Unable to...
771 просмотров
schedule
26.10.2023
Как сделать, чтобы ссылка на главную страницу отображалась
Я начал использовать jsdoc с jaguarjs-jsdoc для создания документации для моего API с помощью node. Он работает довольно хорошо, и я даже могу использовать файл readme.md для создания индексной страницы, но я не могу получить ссылку на индексную...
83 просмотров
schedule
04.10.2022
JSDoc: Как документировать `var self = this;`?
JSDoc отлично подходит для определения методов и свойств, определенных в классе, если вы используете ключевое слово this , например:
/** @class */
function Person(name) {
/** This person's name */
this.name = name;
/** Greet someone */...
762 просмотров
schedule
23.01.2024
Документирование классов Factory Constructor с использованием jsdoc
У меня есть несколько классов, которые следуют шаблону "Factory Constructor" . Они создаются путем вызова фабрики без использования ключевого слова new .
Пример:
/**
* Example "Factory Constructor" class
* @class
*/
function MyClass() {...
261 просмотров
schedule
23.01.2023
Как запустить jsdoc для всего каталога в Ubuntu
Мне просто нужно запустить jsdoc для всего каталога ai, содержащего файлы .js, я делаю это для отдельных файлов в терминале Ubuntu, введя команду jsdoc abc.js, но мне нужно применить эту команду ко всем файлам в каталоге одновременно, так что все...
8973 просмотров
schedule
21.04.2023
Разделение длинного объекта @return с анонимным типом в JSDoc
При использовании анонимного типа @return с JSDoc строка может стать очень длинной. Как разделить эти длинные строки?
Например. начиная с:
/**
* @return {{long_name: string, long_other_name: number, another_name: string, and_still_more:...
106 просмотров
schedule
21.08.2022
Как задокументировать функцию, возвращаемую функцией, с помощью JSDoc, не изменяя последнюю?
Этот вопрос очень похож на другой вопрос в этом site , за исключением того, что есть еще одно ограничение: я не могу модифицировать функцию, которая создает новые функции.
Допустим, у нас есть объект с именем someObject и метод с именем...
51 просмотров
schedule
07.01.2023
Комментарии JSDoc для параметров деструктурирования, не работающих в VSCode
Согласно документу , JSDoc поддерживает параметры деструктуризации:
/**
* Assign the project to an employee.
* @param {Object} employee - The employee who is responsible for the project.
* @param {string} employee.name - The name of the...
1793 просмотров
schedule
22.02.2023
JSDoc 3 conf.json не работает
Я пытаюсь создать проект с использованием JSDoc-3.5.5. В настоящее время я пытаюсь запустить тест на наличие ошибок, используя небольшой образец файлов для проекта. Я вручную включил несколько файлов в свой файл conf.json, но когда я запускаю тест,...
656 просмотров
schedule
12.07.2023
Как документировать объект в конструкторе класса?
В настоящее время я использую JSDoc, чтобы попытаться задокументировать следующий код...
class Test {
/**
* @param {Object} raw The raw data.
*/
constructor(raw) {
/**
* Used for things and stuff. It can be useful when...
357 просмотров
schedule
29.08.2022
