Различия

Здесь показаны различия между двумя версиями данной страницы.

--- nodejs:jsdoc [2022/05/13 10:22]
werwolf [Стандартизация комментариев JavaScript (JSDoc)]
+++ nodejs:jsdoc [2023/01/12 12:18] (текущий)
@@ Строка 13: / Строка 13: @@
 Создание документации по API - это только один аспект. Его основной вклад заключается в стандартизации формата комментариев кода. Возможно, вы не использовали его, но большинство из вас где-то видели в исходном коде формат комментариев, подобный следующему:
-<code>
+<code javascript>
 /**
  * Returns the sum of a and b
@@ Строка 25: / Строка 25: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-<code>
-</code>
 ==== использовать ====
-''Пользоваться инструментом очень просто, сначала установите его:''
+Пользоваться инструментом очень просто, сначала установите его:
-<code>
+<code powershell>
 npm install -g jsdoc
 </code>
-''''<code>
+Во-вторых, предположим, что в ''doc.js'' Напишите в файл следующий код:
-</code>
-  * ''1''
+<code javascript>
-<code>
-</code>
-''Во-вторых, предположим, что в''doc.js'' Напишите в файл следующий код:''
-<code>
 /**
  * Returns the sum of a and b
@@ Строка 80: / Строка 58: @@
 </code>
-''''<code>
-</code>
-  * ''1''
+Затем выполните следующую команду в текущем каталоге:
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-<code>
+<code javascript>
-</code>
-''Затем выполните следующую команду в текущем каталоге:''
-<code>
 jsdoc doc.js
 </code>
-''''<code>
-</code>
-  * ''1''
-<code>
-</code>
-''Наконец, файл с именем''out'' Содержимое текущего каталога станет следующим:''
+Наконец, файл с именем ''out'' Содержимое текущего каталога станет следующим:
-<code>
+<code javascript>
 ├── doc.js
 └── out
@@ Строка 158: / Строка 105: @@
 </code>
-''''<code>
-</code>
-  * ''1''
+Посетите это через браузер ''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам;
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-  * ''19''
-  * ''20''
-  * ''21''
-  * ''22''
-  * ''23''
-  * ''24''
-  * ''25''
-  * ''26''
-  * ''27''
-  * ''28''
-  * ''29''
-  * ''30''
-  * ''31''
-  * ''32''
-  * ''33''
-  * ''34''
-<code>
+Домашняя страница:
-</code>
+{{:nodejs:7a790d6680b04ece105b4d5c9c17efb5.png|}}
-''Посетите это через браузер''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам;''
+Укажите страницу функции:
-Домашняя страница:
+{{:nodejs:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|}}
-{{:images:741:7a790d6680b04ece105b4d5c9c17efb5.png|jsdoc-home.png}}Укажите страницу функции:
+\\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев;
-{{:images:624:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|jsdoc-func.png}}\\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев;
 ==== Формат комментария ====
@@ Строка 215: / Строка 125: @@
 JSDoc использует следующий формат символов комментария для обертывания тегов, которые будут добавлены на уровне блока:
-<code>
+<code javascript>
 /**
  *
@@ Строка 222: / Строка 132: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-<code>
-</code>
-''То есть столбец звездочки выровнен по вертикали. Используйте две звездочки в первой строке и добавьте пробел после каждой звездочки перед записью содержимого, например:''
+То есть столбец звездочки выровнен по вертикали. Используйте две звездочки в первой строке и добавьте пробел после каждой звездочки перед записью содержимого, например:
-<code>
+<code javascript>
 /**
    * Оставьте пробел перед описанием
@@ Строка 243: / Строка 143: @@
 </code>
-''''<code>
+Встроенный пакет:
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-<code>
-</code>
-''Встроенный пакет:''
-<code>
+<code javascript>
 /** @function */
 </code>
-''''<code>
-</code>
-  * ''1''
-<code>
-</code>
 === @description ===
-''Также можно написать''@desc'', Чтобы описать подробную информацию о текущем объекте аннотации;''
+Также можно написать''@desc'', Чтобы описать подробную информацию о текущем объекте аннотации;
-<code>
+<code javascript>
 /**
  * @function
@@ Строка 288: / Строка 169: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-<code>
-</code>
 === @file ===
-''Комментарий записывается в начале файла, чтобы описать соответствующую информацию о текущем файле; например:''
+Комментарий записывается в начале файла, чтобы описать соответствующую информацию о текущем файле; например:
-<code>
+<code javascript>
 /**
    * @file Это файл для ..., содержит ... функции
@@ Строка 319: / Строка 182: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-<code>
-</code>
 === @author ===
-''Опишите соответствующую информацию об авторе текущего файла или кода;''
+Опишите соответствующую информацию об авторе текущего файла или кода;
-<code>
+<code javascript>
 /**
  * @author Jack <jack@example.com>
@@ Строка 341: / Строка 193: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-<code>
-</code>
 === @copyright ===
-''Опишите информацию об авторских правах текущего файла''
+Опишите информацию об авторских правах текущего файла
-<code>
+<code javascript>
 /**
  * @copyright Jack 2020
@@ Строка 361: / Строка 204: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-<code>
-</code>
 === @license ===
-''Опишите информацию, относящуюся к текущей лицензии на файл;''
+Опишите информацию, относящуюся к текущей лицензии на файл;
-<code>
+<code javascript>
 /**
  * @license MIT
@@ Строка 381: / Строка 215: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-<code>
+или:
-</code>
-''или:''
-<code>
+<code javascript>
 /**
  * @license
@@ Строка 408: / Строка 234: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-<code>
-</code>
 === @version ===
-''Опишите номер версии текущего проекта;''
+Опишите номер версии текущего проекта;
-<code>
+<code javascript>
 /**
    * Эта версия исправляет ... проблемы
@@ Строка 438: / Строка 247: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-<code>
-</code>
 === @since ===
-''Опишите, в какой версии была введена функция;''
+Опишите, в какой версии была введена функция;
-<code>
+<code javascript>
 /**
  * Обеспечить ... функцию
@@ Строка 461: / Строка 261: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-<code>
-</code>
 === @see ===
-''Подобно значениям «см. Также» и «см. Подробно», вы также можете использовать его для навигации в другие места.''@link'' Перейти к определенному сетевому адресу;''
+Подобно значениям «см. Также» и «см. Подробно», вы также можете использовать его для навигации в другие места.''@link'' Перейти к определенному сетевому адресу;
-<code>
+<code javascript>
 /**
  * @see fn2
@@ Строка 489: / Строка 279: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-<code>
-</code>
 === @todo ===
-''Опишите, что делать дальше;''
+Опишите, что делать дальше;
-<code>
+<code javascript>
 /**
    * @todo add ... функция
@@ Строка 517: / Строка 292: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-<code>
-</code>
 === @function ===
-''против ''@func'', ''@method'' То же самое означает описание функции;''
+против ''@func'', ''@method'' То же самое означает описание функции;
-<code>
+<code javascript>
 /** @function */
 var myFn = function() {}
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-<code>
-</code>
 === @type ===
-''Опишите тип переменной;''
+Опишите тип переменной;
-<code>
+<code javascript>
 /**
    * Переменная типа объекта
@@ Строка 607: / Строка 364: @@
  */
 var obj3 = {a: 'one', b: 2}
-</code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-  * ''19''
-  * ''20''
-  * ''21''
-  * ''22''
-  * ''23''
-  * ''24''
-  * ''25''
-  * ''26''
-  * ''27''
-  * ''28''
-  * ''29''
-  * ''30''
-  * ''31''
-  * ''32''
-  * ''33''
-  * ''34''
-  * ''35''
-  * ''36''
-  * ''37''
-  * ''38''
-  * ''39''
-  * ''40''
-  * ''41''
-  * ''42''
-  * ''43''
-  * ''44''
-  * ''45''
-  * ''46''
-  * ''47''
-  * ''48''
-  * ''49''
-  * ''50''
-  * ''51''
-  * ''52''
-  * ''53''
-  * ''54''
-  * ''55''
-  * ''56''
-<code>
 </code>
 === @param ===
-''против ''@arg'', ''@argument'' То же самое означает описание информации о параметрах функции;''
+против ''@arg'', ''@argument'' То же самое означает описание информации о параметрах функции;
-<code>
+<code javascript>
 /**
    * За меткой следует тип параметра, затем имя параметра и, наконец, описание параметра.
@@ Строка 747: / Строка 441: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-  * ''19''
-  * ''20''
-  * ''21''
-  * ''22''
-  * ''23''
-  * ''24''
-  * ''25''
-  * ''26''
-  * ''27''
-  * ''28''
-  * ''29''
-  * ''30''
-  * ''31''
-  * ''32''
-  * ''33''
-  * ''34''
-  * ''35''
-  * ''36''
-  * ''37''
-  * ''38''
-  * ''39''
-  * ''40''
-  * ''41''
-  * ''42''
-  * ''43''
-  * ''44''
-  * ''45''
-  * ''46''
-  * ''47''
-  * ''48''
-  * ''49''
-  * ''50''
-  * ''51''
-  * ''52''
-  * ''53''
-  * ''54''
-  * ''55''
-  * ''56''
-  * ''57''
-  * ''58''
-  * ''59''
-  * ''60''
-  * ''61''
-  * ''62''
-  * ''63''
-  * ''64''
-  * ''65''
-  * ''66''
-  * ''67''
-  * ''68''
-<code>
-</code>
 === @typedef ===
-''Используется для описания типов пользовательских переменных;''
+Используется для описания типов пользовательских переменных;
-<code>
+<code javascript>
 /**
    * Описание нестандартного типа
@@ Строка 839: / Строка 459: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-<code>
-</code>
 === @callback ===
-''Опишите информацию о параметрах указанной функции как функцию обратного вызова;''
+Опишите информацию о параметрах указанной функции как функцию обратного вызова;
-<code>
+<code javascript>
 /**
    * Это описание функции обратного вызова
@@ Строка 874: / Строка 478: @@
  */
 function myFn(a, callback) {}
-</code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-<code>
 </code>
 === @returns ===
-''Или напишите''@return'', Информация, описывающая возвращаемое значение функции;''
+Или напишите ''@return'', Информация, описывающая возвращаемое значение функции;
-<code>
+<code javascript>
 /**
  * @param {number} a
@@ Строка 920: / Строка 504: @@
     }
 }
-</code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-  * ''19''
-<code>
 </code>
 === @example ===
-''Опишите пример использования указанного кода;''
+Опишите пример использования указанного кода;
-<code>
+<code javascript>
 /**
    * Добавьте образец кода (формат будет выделен)
@@ Строка 968: / Строка 526: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-<code>
-</code>
 === @class ===
-''Опишите''class'' учебный класс;''
+Опишите ''class'' учебный класс;
-<code>
+<code javascript>
 /**
    * Описание категории
@@ Строка 1005: / Строка 544: @@
 function MyClass() {}
 var ins = new MyClass();
-</code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-<code>
 </code>
 === @namespace ===
-''Опишите пространство имен;''
+Опишите пространство имен;
-<code>
+<code javascript>
 /**
    * Укажите объект в пространстве имен
@@ Строка 1061: / Строка 581: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-  * ''17''
-  * ''18''
-  * ''19''
-  * ''20''
-  * ''21''
-  * ''22''
-  * ''23''
-  * ''24''
-  * ''25''
-  * ''26''
-  * ''27''
-  * ''28''
-<code>
-</code>
 === @member ===
-''Описать член текущего класса;''
+Описать член текущего класса;
-<code>
+<code javascript>
 /**
  * @class
@@ Строка 1113: / Строка 599: @@
      */
 }
-</code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-<code>
 </code>
 === @memberof ===
-''Опишите класс, к которому принадлежит член;''
+Опишите класс, к которому принадлежит член;
-<code>
+<code javascript>
 /**
  * @class
@@ Строка 1157: / Строка 624: @@
 </code>
-''''<code>
-</code>
-  * ''1''
-  * ''2''
-  * ''3''
-  * ''4''
-  * ''5''
-  * ''6''
-  * ''7''
-  * ''8''
-  * ''9''
-  * ''10''
-  * ''11''
-  * ''12''
-  * ''13''
-  * ''14''
-  * ''15''
-  * ''16''
-<code>
-</code>
-----
-''Техническая статья push''
-''''''Мобильный телефон, совместное использование компьютерных программ''
-''''''{{:images:120:2ae90fe6000212299609e1d534fdcb90.png}}''''{{:images:41:d2693e202c52e9435386b3e93ab89d71.png}}'''''''' ''''     (function () {
-        var size='728x90|300x250',
-            adunit = 'russianblogs.com_728x90_responsive_5_DFP',
-            childNetworkId = '22396446015',
-            xmlhttp = new XMLHttpRequest();xmlhttp.onreadystatechange = function(){if(xmlhttp.readyState==4 && xmlhttp.status==200){var es = document.querySelectorAll("[data-id='"+adunit+"']");var e = Array.from(es).filter(function(e) {return !e.hasAttribute("data-rendered")});if(e.length > 0){e.forEach(function(el){var iframe = el.contentWindow.document;iframe.open();iframe.write(xmlhttp.responseText);iframe.close();el.setAttribute%%('%%data-rendered', true)})}}};var child=childNetworkId.trim()?','+childNetworkId.trim():%%''%%;xmlhttp.open("GET", 'https://pubads.g.doubleclick.net/gampad/adx?iu=/147246189'+child+%%'/'%%+adunit+'&sz='+encodeURI(size)+'&t=Placement_type%3Dserving&'+Date.now(), true);xmlhttp.send();})();
- ''
-----
-==== Интеллектуальная рекомендация ====
-==== Функция-член swap в контейнере ====
-Функция-член swap в контейнере В векторе контейнера пространство, занимаемое его памятью, только увеличивается, например, сначала выделяется 10 000 байт, а затем стираются следующие 9 999. Хотя сущест...
-[[:article:75162013247:|{{:thumbs:626:ff543664ef28c1d9e5b5727a6584023a.png}}]]==== Маленькое Мин яблоко ====
-Просто смотрите этот вопрос, я не хочу это делать, я чувствую себя слишком просто. Отказ Отказ На самом деле, это также очень просто, это низкие руки. Неудачный код: #include <cstdlib> #include ...
-[[:article:959886144:|{{:thumbs:47:1f659a8bc91cb1ff8df73ebcf156ee17.png}}]]==== Запрос разбивки на базы данных Oracle ====
-Например, есть такая таблица Я хочу узнать данные 3-6   Также может быть так...
-[[:article:46621349598:|{{:thumbs:348:08883cc9504f990e56b80e97344f7a7c.JPEG}}]]==== Ubuntu16.04 установка записи процесса OpenCV ====
-. Установите зависимости и инструменты OpenCV. 2. Загрузите исходный код OpenCV и функции библиотеки и разархивируйте 3. Настройте среду Python. 4. Создайте виртуальную среду. 5. Включите виртуальную...
-[[:article:36122250290:|{{:thumbs:289:8551b650c6dd2bd188894efd043bc8b9.gif}}]]==== Весенняя загрузка + Vue Все развитие стека делает что-то внешнее знание? ====
-axios Во-первых, Axios Instruction Axios - это проект, независимый от VUE, основанный на обещании для браузера и Node.js, HTTP-клиента Может помочь нам завершить отправку запросов AJAX в вашем браузер...
-==== Вам также может понравиться ====
-[[:article:48472520378:|{{:thumbs:792:6b9bde28ab3071588e8864fa0558d0b8.png}}]]==== PostgreSQL index Простой взгляд на индекс PG Создать параллельные принципы ====
-Это долгая длинная история, введенная из PG 8.3, в кортеже, основная роль используется для уменьшения количества ввода / вывода, необходимого для обновлений, и обновление на основе принципов на основе...
-[[:article:8866680506:|{{:thumbs:475:66d35ed380f9cbac9aa1993b66114d1b.png}}]]==== eclipse + maven настроить среду проекта SSM (для идеи) ====
-После того, как редактор идей сам создаст новый проект maven, просто сделайте остальные следующим образом. Перед тем, как приступить к написанию учебного пособия, я создал проект maven для веб-разрабо...
-[[:article:91722056182:|{{:thumbs:869:da39722834397aa65c2ba88e57fcbafd.png}}]]==== 124. Binary Tree Maximum Path Sum ====
-Given a non-empty binary tree, find the maximum path sum. For this problem, a path is defined as any sequence of nodes from some starting node to any node in the tree along the parent-child ...
-[[:article:48251354469:|{{:thumbs:631:7d504971d2462984c9cd977f7629a437.JPEG}}]]==== Научите вас получать ISA за несколько простых шагов ××× ====
-Формирование ISA ××× В последнее время в связи с бизнес-потребностями компании и реализацией в будущем резервного канала ×××, автору необходимо установить серверы &...
-[[:article:92601051594:|{{:thumbs:962:1e719f507bfba88b5e8c28cf6d2399ba.png}}]]==== Массив Java ====
-Каталог статей 1. Что такое массив 2. Определение и инициализация массива. 2.1, определение массива 2.2, статическая инициализация массива 2.3, динамическая инициализация 3. Операция с массивом 3.1, и...

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы