Публикации по теме 'jsdoc'
TypeScript или JSDoc?
Понимание различий
В мире веб-разработки JavaScript стал основой для создания интерактивных и динамических веб-приложений. Однако по мере того, как проекты становятся больше и сложнее, разработчики часто сталкиваются с проблемами в поддержании качества кода и обнаружении потенциальных ошибок на раннем этапе.
Именно здесь вступают в игру такие инструменты, как TypeScript и JSDoc. И TypeScript, и JSDoc нацелены на улучшение опыта разработки и расширение базы кода JavaScript. В этой..
JSDoc и общие типы. Машинопись
JSDoc и общие типы. Машинопись
В этой статье я объясню, как использовать Typescript с JSDoc , и покажу 2 способа создания общих типов в ваш код.
То, что я собираюсь показать, работает с модулем как ES5 , так и ES6 . Мой набор инструментов - VSCode в конфигурации по умолчанию без расширений .
Дженерики в JSDoc
Тег @template определяет общий тип. Просто используйте его как обычный тип в нотации JSDoc:
Простая функция определяется ,..
Вопросы по теме 'jsdoc'
Инструментарий JsDoc и пространство имен - Предупреждение о попытке .. без
Я использую jsdoc-toolkit с библиотека пространств имен Майка Косса . Код выглядит так
namespace.module('a.b', // this is the namespace
// @param {Object} exports visible classes within this namespace
// @param {function} required other...
988 просмотров
schedule
08.04.2024
Как документировать исходный код CoffeeScript с помощью JSDoc?
У меня есть код, написанный на CoffeeScript, и я хочу оптимизировать сгенерированный JavaScript с помощью Google Closure Compiler, поэтому эти файлы необходимо документировать с помощью JSDoc.
Мой вопрос: как я могу документировать файлы *.coffee...
17422 просмотров
schedule
10.12.2022
Определите параметры в JSDoc для встроенных анонимных функций.
Если я определяю функцию как переменный объект, тогда PhpStorm покажет автозаполнение для параметра item .
/**
* @param {Rules.FolderGroupItem} item
**/
var forEach = function(item) {
if(item.type ==...
1101 просмотров
schedule
12.12.2023
Статический метод класса пространства имен javascript jsdoc
Я пытаюсь использовать jsDoc в своем коде js, в котором я хочу определить: - Пространство имен. - Класс. - Статический метод. Обратите внимание, что код делает именно то, что я ожидаю во время выполнения, но у меня проблемы с началом работы с...
3553 просмотров
schedule
04.01.2024
Каково правильное/каноническое форматирование длинных строк JSDoc?
Все официальные примеры JSDoc имеют наивно простые строки документации, такие как следующие:
/**
* @param {string} author - The author of the book.
*/
Проблема в том, что в реальной документации часто используются более длинные строки...
9382 просмотров
schedule
30.11.2023
Как использовать аннотации машинописного текста jsdoc для React PropTypes
При определении компонентов реакции с помощью машинописного текста мы можем написать что-то вроде:
class SomeComponent extends React.Component<PropInterface, StateInterface> {
// ...
}
Есть ли способ сделать эквивалент, используя...
10564 просмотров
schedule
13.12.2022
Как получить точное сообщение об ошибке JsDoc в reactjs?
Мы используем JsDoc для создания нашего документа страниц reactjs. Все комментарии, которые мы написали в соответствии с правилом jsDoc, все же отображают ниже сообщение для какой-то страницы:
ОШИБКА: невозможно проанализировать...
280 просмотров
schedule
06.05.2024
Как документировать @typedef как @memberof @namespace
Я должен указать, что я использую VSCode в качестве своей IDE.
Вопрос
Как задокументировать @typedef так, чтобы он был членом @namespace ? (Я открыт для @module или других тегов JSDoc для достижения этого, но, похоже, с этим подходом я...
1460 просмотров
schedule
02.11.2023
Несколько строк в определении объекта JSDoc
Я фасадный модуль NodeJS, который упрощает взаимодействие с Shopify API для нужд моего бэкенда. У меня есть функция, которая возвращает обещание, которое при разрешении содержит объект с информацией о магазине (идентификатор, адрес электронной почты,...
686 просмотров
schedule
04.12.2023
Как показать предупреждение при неправильном использовании функций в соответствии с JSDoc?
Я использую JSDoc для документирования своих функций Javascript и добавления аннотаций типов.
В Visual Studio я получаю Intellisense для этих функций, и это здорово. Однако, если я использую неправильный тип (например, целое число для параметра,...
1031 просмотров
schedule
30.12.2023
Функция утверждения типа в JSDoc
Я пытаюсь придумать вариант JavaScript + JSDoc следующей функции подтверждения типа TypeScript:
function typeCheck<T>(value: unknown, type: new () => T) {
if (value instanceof type) {
return value;
}
throw new...
57 просмотров
schedule
10.05.2024
