Публикации по теме 'jsdoc'
Создание JS-приложений с помощью JSDoc и TypeScript
Создание JS-приложений с помощью JSDoc и TypeScript
Существуют смешанные чувства по поводу использования языка с динамической типизацией, такого как JavaScript, при создании больших приложений. Я здесь не для того, чтобы бороться за JavaScript, а не за Typescript. Однако я покажу, как мы можем писать чистый JavaScript и использовать Typescript и JSDoc, чтобы помочь в этом.
Поскольку мы стремимся быть разработчиками чистого кода, нас учат, что комментарии — это плохо ...
JSDoc 101
Я использую JSDoc уже некоторое время, и в связи с недавней шумихой из-за миграции Svelte, сегодня я пришел поделиться советами и тем, как их использовать.
Это самые основы того, что вам понадобится.
Машинопись
Синтаксис для некоторых вещей отличается, но для большинства вещей просто думайте об этом как о Typescript, и все будет в порядке.
файлы .d.ts
Я обычно использую их для вспомогательных и служебных типов (их проще создать, особенно с дженериками, и потом их можно просто..
Документирование кода JavaScript с помощью JSDoc
JSDoc обеспечивает добавление типов в кодовую базу JavaScript с соответствующими соглашениями внутри комментариев, поэтому различные IDE, такие как Visual Studio Code, могут распознавать определенные типы, отображать их и упрощать кодирование с помощью автодополнения. Определения помещены внутри /** */ комментариев.
Примеры
Пользовательские типы можно определить с помощью тегов @typedef и @property . Каждое свойство имеет тип, и если свойство является необязательным, его имя..
Улучшите свой JavaScript с помощью магии документации 📖 💫
Почему и как нужно документировать модульный JavaScript!
В прошлом посте я говорил о том, почему мы должны модулировать наш JavaScript :
Следующий шаг на пути к JavaScript Самая универсальная истина, которую я могу придумать:« Мы все хотим меньше сосать . medium.com»
В этом посте мы действительно запачкаем руки!
Почему мы должны документировать 📝
Когда мы пишем модульный JavaScript и начинаем перемещать функции в отдельные..
JSDoc частые шаблоны
JSDoc частые шаблоны
Ранее я писал сообщение на тему Зачем нужен JSDoc . На этот раз я углублюсь в детали и расскажу о нескольких из наиболее частых шаблонов, которые я использую.
Базовый объект
Используйте @typedef @type для описания объекта. Вы также можете оставлять необязательные комментарии.
Ограниченный набор ценностей
Смешайте набор значений, чтобы создать новый тип.
Функция
Используйте @param @return , чтобы добавить описание к функциям...
Как создать документацию JSDoc для проекта TypeScript React
Во-первых, игнорируйте папку docs, если вы не хотите, чтобы документы находились в репозитории, добавив:
/docs to .gitignore file
2. Создайте файл jsdoc.conf.json со следующим содержимым:
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc", "closure"]
},
"source": {
"include": ["src"],
"includePattern": "\\.(jsx|js|ts|tsx)$",..
Вопросы по теме 'jsdoc'
Как задокументировать обработчик событий в JSDoc?
Предположим, у меня есть такой класс:
function myClass(q) {
this.someFunction = function(e) {
console.log("Click event");
};
jQuery(q).click(this.someFunction);
}
Есть ли способ указать JSDoc, что someFunction — это не просто...
7744 просмотров
schedule
18.08.2022
Генератор документации JavaScript, совместимый с jQuery
Мне нужно выбрать генератор документации (похожий на jdoc в java или rdoc в ruby) для моего проекта javascript, который (созданный с помощью jquery, подчеркивания и магистрали)
Кандидаты:
инструментарий jsdoc
pdoc
натуральные документы...
8815 просмотров
schedule
26.11.2022
Как документировать список аргументов переменной длины с известными типами параметров?
Связано: Правильный способ документирования открытых аргументных функций в JSDoc
У меня есть функция, которая принимает несколько массивов, обращаясь к переменной arguments :
/**
* @param options An object containing options
* @param...
3330 просмотров
schedule
24.11.2022
Как мне аннотировать мое использование этого компилятору закрытия в следующей функции Javascript?
Я использую следующую функцию для изменения поведения конкретного экземпляра массива Javascript. Как я могу аннотировать код для Closure Compiler? http://code.google.com/closure/compiler/docs/js-for-compiler.html Выполнение кода через компилятор...
367 просмотров
schedule
06.02.2023
Как избежать знака @ внутри комментариев JSDoc в NetBeans
У меня есть простой метод в API, который позволяет искать объекты с помощью JSONPath. Поскольку его синтаксис практически незнаком младшим разработчикам, я решил привести несколько примеров в комментарии JSDoc. Однако вот в чем загвоздка: знак @...
3180 просмотров
schedule
12.01.2023
backbone.js + require.js + jsdoc3: Отсутствует проблема с зависимостями в jsdoc
Я пытаюсь задокументировать свое модульное магистральное приложение с помощью jsdoc3. Однако я получаю сообщение об ошибке «исключение из неперехваченного броска JavaScript: ошибка: отсутствует зависимость: Backbone.model», когда я пытаюсь запустить...
769 просмотров
schedule
20.04.2022
Есть ли способ избежать использования аннотации JSDoc @method
Лично я не большой поклонник сгенерированной документации (я больше люблю "читать исходный код Люка"), но я вижу, как такая документация может быть полезна другим. Обычно их создание документации не влияет на меня, за исключением одного: @method....
3672 просмотров
schedule
12.04.2022
Как документировать проект AMD + Backbone с помощью JSDoc3
У меня есть проект на основе базового шаблона , который я хочу задокументировать с помощью последних jdoc-toolkit
Хотя я не могу заставить его генерировать что-либо, кроме пустого класса _global
Пример кода:
/**
* This is a root model...
743 просмотров
schedule
24.04.2024
Альтернатива @name для документирования свойств `this`
Мне интересно, как документировать свойства this. функции конструктора класса. Например, я пробовал использовать тег @name для именования своего класса, но он не создал документацию для this.foo :
/**
* @name ClassName
* @constructor
*/...
1183 просмотров
schedule
27.09.2022
Почему JSDoc объединяет комментарии к документам во всех модулях JS в одном файле?
У меня есть несколько файлов JS (модули AMD) в каталоге. Когда я запускаю команду jsdoc, она создает файл index.html, в котором есть комментарии для всех методов во всех файлах. Почему он объединяет все методы в один файл?
Я использую следующую...
1632 просмотров
schedule
22.03.2023
Документирование параметров универсального типа в JSDOC
В JSDoc существует возможность документировать точные типы содержимого массива вот так :
/** @param {Array.<MyClass>} myClasses An array of MyClass objects. */
TestClass.protoype.someMethod = function( myClasses ){...
21372 просмотров
schedule
12.01.2023
Функции документации jsdoc внутри модуля
У меня такой код:
/**
* @fileOverview Various tool functions.
* @version 3.1.2
*/
define(function (require, exports, module) {
"use strict";
/**
* A module that handles file
* @module fileHandler
*/...
1780 просмотров
schedule
05.07.2022
Можно ли указать jsdoc искать документацию по этому коду в отдельном от исходного кода файле?
Я хотел бы, чтобы встроенные комментарии были как можно короче, поскольку, по моему опыту, комментарии длиной более 3 или 4 строк имеют тенденцию замалчиваться, создавая много ненужных строк «прочитайте руководство».
По наследству я обязан...
3769 просмотров
schedule
15.04.2023
Как правильно документировать тип параметра jQuery с помощью JSDoc?
Я пытаюсь задокументировать свою программу с синтаксисом JSDoc для себя и людей, которым придется смотреть на мой код. Я также пытаюсь улучшить свои навыки.
Для параметра типа jQuery я немного озадачен. Я знаю, что это объект, но он довольно...
7905 просмотров
schedule
11.11.2022
Проблема jsdoc: отображается полный путь к исходному файлу (нежелательно)
Я использую jsdoc3 для своего проекта, и все прекрасно компилируется.
Но с этим я возился последние 2 дня и сдаюсь :(
При использовании самого простого вызова терминала MacOsX для запуска jsdoc я ВСЕГДА получаю полный путь к моему исходному...
795 просмотров
schedule
29.05.2023
jsDoc @constructs не наследуется путем расширения объектов?
Я использую @lends + @constructs + @augments для определений классов MooTools (настраиваемый вариант пространства имен), однако у меня возникают некоторые проблемы с проверкой в PhpStorm в расширяющих классах, если я не включаю инициализацию в...
378 просмотров
schedule
10.06.2024
Документирование свойства и метода прототипа с помощью JSDoc-3.3.0-alpha5
У меня есть класс с именем FileDownloader , и я пытался его задокументировать, но свойства и метод, объявленные с использованием prototype , не генерируются в выходном файле.
Как указано в заголовке, я использую jsdoc 3.3.0-alpha5.
Вот код:...
1449 просмотров
schedule
02.03.2024
@type для экспортированных модулей из node.js и хорошее описание документации?
Я пытаюсь быть хорошим гражданином и документировать свои модули узлов .... но я не уверен, что добавить в @type. Я использую webstorm, поэтому он автоматически помещает @type {exports}, но я немного запутался, что я должен туда поместить?...
2975 просмотров
schedule
11.02.2023
Закрытие аннотации для функции с переменным числом аргументов
Я пишу код для компиляции Google Closure Compiler в расширенном режиме компиляции. В некоторых местах моего кода у меня есть вариативные функции, которые я обычно пишу с пустым списком аргументов. Я бы получил доступ к переданным аргументам,...
778 просмотров
schedule
14.12.2023
Дополнительные параметры промежуточной функции документа
Существует ли правильный синтаксис для документирования необязательных параметров JavaScript, где необязательный параметр находится в середине заголовка функции (например, jQuery, Gulp и т. д.)
Я задокументировал функцию стандартным способом, и она...
414 просмотров
schedule
31.08.2022
