Вопросы по теме 'jsdoc3'
JSDoc с AngularJS
В настоящее время в моем проекте мы используем JSDoc, недавно мы начали внедрять Angular, и я хочу продолжать использовать JSDoc, чтобы убедиться, что вся документация находится в одном месте.
Я посмотрел на людей, в основном просто говорящих...
23242 просмотров
schedule
03.07.2023
Документирование сложных объектов JavaScript с помощью пользовательской системы наследования
В настоящее время я пытаюсь перенести существующий API-интерфейс JavaScript на стороне сервера из существующей системы наследования с копированием и вставкой вручную в лучшую и более надежную систему. Чистое прототипирование нельзя использовать,...
285 просмотров
schedule
28.06.2023
Как аннотировать элементы/свойства @readonly-but-modified-internally в JSDoc?
JSDoc имеет тег @readonly doclet :
Тег @readonly указывает, что символ предназначен только для чтения.
Например:
/**
* The name of the represented principal
* @member {string}
* @readonly
*/
this.name = primaryName;
Однако я...
434 просмотров
schedule
31.12.2022
Документирование методов модели мангуста с помощью jsdoc
Я пытаюсь документировать методы модели мангуста с помощью jsdoc. Метод модели принадлежит модели, поэтому я хотел бы видеть его как метод-член.
Файл также содержит строку @module models верхнего уровня.
/**
* @constructor
*/
var MySchema...
2435 просмотров
schedule
11.03.2023
JSDoc: вернуть структуру объекта
Как я могу сообщить JSDoc о структуре возвращаемого объекта. Я нашел синтаксис @return {{field1: type, field2: type, ...}} description и попробовал:
/**
* Returns a coordinate from a given mouse or touch event
* @param...
83667 просмотров
schedule
04.05.2023
Использование JSDoc с AMD
У меня есть следующая структура AMD для моих модулей.
/* globals define */
define([""], function() {
'use strict';
var module = {};
function _somePrivateFunc() {}
function somePublicFunc() {}
module.somePublicFunc =...
291 просмотров
schedule
04.03.2024
JSDoc: Как избежать дублирования документации для свойств / геттеров?
В настоящее время я документирую один из своих API с помощью JSDoc. Хотя это работает хорошо, одна вещь, которая меня действительно раздражает, - это дублирование документации. Одним из распространенных примеров этого является документация свойства...
1515 просмотров
schedule
20.03.2022
Вывод JSDoc несовместим с gulp-jsdoc и стандартным интерфейсом командной строки
Я пытаюсь создать документы для простого набора кода JS (приведенного ниже). Если я использую gulp, документы создаются так, как я ожидаю. Если я использую CLI, документы будут неполными.
Вот мой JS-код:
// BASE.js
/** @module BASE */
var...
511 просмотров
schedule
24.05.2024
JSDOC: Можно ли сделать ссылку на свойство модуля?
Я хотел бы знать, можно ли связать один модуль со свойством/методом другого модуля.
Что я пробовал до сих пор, но не работал:
/**
* {@link module:modules/modulName#id}
*/
Мои модули следуют этому шаблону:
/**
* @module...
2178 просмотров
schedule
07.02.2023
Каков канонический шаблон для экспорта перечислений в модуль JavaScript?
Я хочу знать канонический шаблон для экспорта перечислений из модуля JavaScript с использованием require и jsdoc. Существующие примеры и вопросы, кажется, рассматривают только локальные частные перечисления. Моя цель — иметь наилучшее качество...
654 просмотров
schedule
01.04.2023
AMD + Backbone + JSDoc3 лучший способ документирования
Я ищу лучший способ документировать свой код, но ничего не нахожу.
Я видел другие темы, в том числе эту , но там все не решает мою проблему.
У меня есть что-то вроде этого:
define([
'backbone'
], function (Backbone) {
/**
*...
158 просмотров
schedule
20.05.2023
JSDOC: как документировать внутренние переменные функции
Есть ли способ заставить JSDOC отображать переменные внутри функций без использования аннотации @namespace перед функцией?
Я сделал небольшой тестовый объект, но он будет отображать только внутреннюю переменную k для последней функции, которая...
3034 просмотров
schedule
31.12.2022
JSDoc: как добавить функции в панель навигации
В шаблоне jsdoc по умолчанию панель навигации создается в функции publish.js buildNav .
e.g.
nav += buildMemberNav(members.events, 'Events', seen, linkto);
Однако members.functions нет.
Я хотел бы знать, как перечислить все функции...
601 просмотров
schedule
09.04.2023
Каков правильный синтаксис JSDoc для локальной переменной?
Для такой функции...
function example() {
var X = 100;
...
var Y = 'abc';
...
return Z;
}
Мне нужно объяснить назначение некоторых локальных переменных. Добавление подобного описания...
function example() {
/**
*...
14848 просмотров
schedule
18.09.2022
Как сослаться на @class в другом файле с помощью JSdoc?
Например. MyClass.js
/**
* @class
* @name module:Bar
* @param {number} a1
* @param {string} a2
*/
function Bar(a1, a2){}
И в другом файле:
/** @type module:Bar.constructor */ // made up syntax
var Bar = require("./MyClass.js");...
8689 просмотров
schedule
28.01.2023
jsdoc: ссылка на тип typedef из другого модуля
Предполагая, что у меня есть тип typedef в модуле js
// somewhere/foo.js
/**
* @module
*/
/**
* @typedef Foo
* @type {object}
* property {string} bar - some property
*/
Можно ли ссылаться на этот тип в другом модуле, чтобы на...
11503 просмотров
schedule
09.01.2023
JSDoc создается онлайн
Есть ли способ генерировать html из jsdocs онлайн или с помощью отдельного инструмента? Я создал внутреннюю JS-библиотеку и задокументировал ее с помощью спецификаций JSDoc, а теперь хотел бы создать документацию, чтобы поделиться ею со своей...
5510 просмотров
schedule
25.07.2023
Как изменить цвет текста JSDoc по умолчанию?
Я использую JSDoc для создания документации для моей библиотеки JS. Содержимое HTML по умолчанию, сгенерированное из JSDoc, имеет серый цвет текста и очень трудно читается. Теперь я хотел бы изменить цвет текста на черный/синий. есть ли способ...
994 просмотров
schedule
23.01.2023
массив allowUnknownTags не работает
У меня есть последняя версия JsDoc (3.4.3), и, согласно документации JsDoc, я добавил массив неизвестных тегов, но получил пощечину с ошибкой неизвестного тега.
Тег @foo: не является известным тегом. "allowUnknownTags": [ "foo", "использование",...
95 просмотров
schedule
16.02.2023
JSDoc - это то, как вы помечаете @typedef как @global?
Просто убедитесь, что это в модуле на нашем Node-сервере — это правильный способ использовать @typedef во всем приложении, а не повторять его в каждом модуле/файле, который необходим. Из документов я не могу определить, правильно это или нет, и...
1738 просмотров
schedule
24.06.2022
