Публикации по теме 'jsdoc'
TypeScript против JSDocs: кто победит?
Раскройте всю мощь JavaScript
TypeScript против JSDocs: кто победит?
Откройте для себя битву за безопасность типов и документацию, чтобы ускорить ваши проекты!
В мире разработки JavaScript два популярных инструмента выделяются, когда речь идет о добавлении аннотаций типов и улучшении документации кода: TypeScript и JSDocs. Хотя оба они служат одной и той же цели, они имеют разные подходы и предлагают уникальные функции. В этой статье мы рассмотрим ключевые различия между..
Документы JS: краткое руководство
JSDocs — это способ документировать и добавлять информацию в написанный нами код. Эта информация отображается во всплывающей подсказке и облегчает разработчикам использование нашего кода.
JSDocs также является генератором документации API, который сканирует файлы и создает документацию на основе документации JSDocs, добавленной к файлам.
Вы также можете конвертировать JSDocs в TypeScript, что упрощает преобразование из ванильного JavaScript в TypeScript.
Это краткое руководство..
Проверка типов в простом Javascript без Typescript: введение в JSDoc
Что, если я скажу вам, что существует некий компромисс между простым Javascript со всей его гибкостью и структурой TypeScript? В этой краткой статье мы познакомимся с решением, которое мне нравится использовать в личных и профессиональных проектах.
Условие:
Некоторые базовые знания JavaScript/Typescript Код Visual Studio (рекомендуется) NodeJs, Deno или другие
Но сначала позвольте мне представить несколько концепций, прежде чем углубляться в конкретные примеры.
Введение..
Использование TypeScript без TypeScript 😎 // Пуру Виджай
Читайте в моем блоге в светлой, темной или дневной теме
Прежде чем начать, я хочу убрать это с пути: если ваша реакция на прочтение заголовка была хоть сколько-нибудь близка к реакции Гермионы 👇
Не беспокойтесь. Я не сошел с ума, и вы тоже не сойдете после прочтения этого
Почему это так долго? 🤔
Эта статья длится около 20 минут. Причина, по которой он такой длинный, заключается в том, что в нем подробно рассматривается, почему вы должны рассмотреть этот подход, и есть..
Руководство по документации кода
Если вы не верите, что ваш код самодокументирован, и следуете правилу, согласно которому документация является неотъемлемой частью хорошего проекта, возможно, вы найдете здесь несколько интересных моментов о создании документации из комментариев к коду.
Очень здорово, что есть такие отличные проекты, как sphinx или jsdoc , которые помогают нам легко генерировать удобочитаемую документацию из исходного кода.
И ниже некоторые мои рекомендации, как заполнить документацию по коду с помощью..
Вопросы по теме 'jsdoc'
Лучший способ документировать анонимные объекты и функции с помощью jsdoc
Изменить: технически это вопрос из двух частей. Я выбрал лучший ответ, который охватывает вопрос в целом и связан с ответом, касающимся конкретного вопроса.
Как лучше всего документировать анонимные объекты и функции с помощью jsdoc?
/**
*...
59596 просмотров
schedule
13.05.2023
Почему jQuery не использует JSDoc?
Или они есть и этого просто нет в исходниках? Мне бы очень хотелось получить что-то, что не даст js-doc-toolkit сходить с ума каждый раз, когда он анализирует jQuery. Это также означает, что я не могу должным образом задокументировать какой-либо...
9958 просмотров
schedule
19.06.2022
Поддержка JSDoc в IntelliJ IDEA
Имеется ли документация по подмножеству, надмножеству или сочетанию этих двух JSDoc ? IntelliJ поддерживает? Моя мотивация использования JSDoc двояка:
Для разработчиков: чтобы IntelliJ мог обеспечить лучшее завершение кода, проверку кода,...
5919 просмотров
schedule
06.02.2023
как документировать вариативный параметр в jsdoc?
как документировать вариативный параметр в jsdoc? и есть ли способ документировать параметр типа «Массив строк»?
1339 просмотров
schedule
15.06.2023
Как описать аргументы объекта в jsdoc?
// My function does X and Y.
// @params {object} parameters An object containing the parameters
// @params {function} callback The callback function
function(parameters, callback) {
}
Но как мне описать, как должен быть структурирован объект...
174000 просмотров
schedule
01.07.2023
Объявление/вывод типа в Eclipse/JSDT
Я хотел бы указать в Eclipse/JSDT тип переменной экземпляра, как в следующем примере:
/**
* @constructor
*/
function A() {
/** @type Node */
this.x = document.createElement("p");
}
Однако среда IDE не распознает тип x . С другой...
770 просмотров
schedule
14.10.2022
Ищу: Пример использования jsDoc с Webstorm IDE (v 4)
Я все еще изучаю js и пробую IDE Webstorm, которая кажется приятной (включая переход к объявлениям var/function).
Я вижу, как получить шаблон для комментария jsdoc, но у меня нет опыта работы с ним, и я ищу пример того, как предоставить более...
5102 просмотров
schedule
06.07.2022
Как документировать подпространство имен с помощью JSDoc при использовании шаблона модуля
Я пытаюсь документировать функции внутри определенного шаблона модуля с помощью jsdoc-toolkit, где пространство имен определяется вне модуля. Функции, которые к нему присоединяются, находятся внутри непосредственно вызывающей функции. Что я получаю...
3403 просмотров
schedule
10.02.2023
Документация JSDoc и JavaScript singleton
У меня есть синглтон JavaScript, определенный как:
/**
* A description here
* @class
*/
com.mydomain.ClassName = (function(){
/**
* @constructor
* @lends com.mydomain.ClassName
*/
var ClassName = function(){};
/**
* method description
*...
3169 просмотров
schedule
25.06.2022
Предлагаемый макет класса JSDoc
Я новичок в JSDoc и пытаюсь найти лучший способ пометить свой код тегами. По какой-то причине после того, как я пометил что-то как @class, я не могу заставить что-либо отображаться как @inner:
/**
* The logger, to simply output logs to the...
229 просмотров
schedule
12.07.2023
JsDoc удваивает количество моих занятий
Я использую расширение класса Джона Резига для создания набора компонентов, и я использую JsDoc для создания документации к ним. Когда я создаю "класс" следующим образом:
/**
* Tests a thing to see what it is, baby
* @param {string=}Id the...
242 просмотров
schedule
05.04.2023
JSDoc с AngularJS
В настоящее время в моем проекте мы используем JSDoc, недавно мы начали внедрять Angular, и я хочу продолжать использовать JSDoc, чтобы убедиться, что вся документация находится в одном месте.
Я посмотрел на людей, в основном просто говорящих...
23242 просмотров
schedule
03.07.2023
Документирование сложных объектов JavaScript с помощью пользовательской системы наследования
В настоящее время я пытаюсь перенести существующий API-интерфейс JavaScript на стороне сервера из существующей системы наследования с копированием и вставкой вручную в лучшую и более надежную систему. Чистое прототипирование нельзя использовать,...
285 просмотров
schedule
28.06.2023
Определите тип JSDoc с помощью переменной [удобно для WebStorm]
В следующем коде я хотел бы определить форму типа ApplicationSettings с помощью переменной testSettings , чтобы внутри IDE функции useSettings было известно, какие свойства доступны для объекта settings :
/** @typedef ApplicationSettings */...
697 просмотров
schedule
12.07.2022
Создание документации AngularJS без использования grunt/bower
У нас есть проект angularJS , и мы используем нотацию @ngdoc , как показано в исходном коде angular, однако мы не используем grunt/bower и хотели бы создать документацию. Есть ли программа, которая делает это, не полагаясь на файлы конфигурации...
440 просмотров
schedule
03.07.2023
Тип JSDoc равен члену массива
Скажем, у меня есть массив строк.
/** @type Array.<string> */
var possibleValues = ['a','b','c','d'];
У меня есть функция, которая принимает строку, однако я хочу, чтобы она была равна только одному из членов possibleValues .
/**...
190 просмотров
schedule
19.02.2023
Это JSDoc? Что это значит?
Я использую NetBeans с архетипом проекта HTML5.
Один из автоматически сгенерированных блоков документации для моей функции (после ввода /** ‹enter›) содержит следующую строку:
@type @exp;generateErrorClass@pro;ctor|Функция
Референтная...
150 просмотров
schedule
16.07.2023
как разместить контроллеры в модулях с помощью ngdoc
Я использую модуль grunt grunt-ngdocs, и это код, который создает документацию.
ngdocs: {
all: app_files,
scripts: ['angular.js']
}
У меня есть модуль под названием starter и два контроллера: controllerA,...
2585 просмотров
schedule
18.07.2022
Как аннотировать элементы/свойства @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
Предупреждение о реализации интерфейса Webstorm с использованием JSDoc
Я очень новичок в JSDoc, и я пробую Webstorm, так что я также новичок в webstorm.
С одной стороны, у меня есть интерфейс, объявленный таким образом:
/** @interface */
function IInterface(){}
IInterface.prototype.myMethod = function(){};
С...
983 просмотров
schedule
21.09.2022
