Различия

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

--- nodejs:jsdoc [2022/05/13 10:30]
werwolf
+++ 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>
 ==== использовать ====
-''Пользоваться инструментом очень просто, сначала установите его:''
+Пользоваться инструментом очень просто, сначала установите его:
-<code>
+<code powershell>
 npm install -g jsdoc
 </code>
-Во-вторых, предположим, что в''doc.js'' Напишите в файл следующий код:
+Во-вторых, предположим, что в ''doc.js'' Напишите в файл следующий код:
-<code>
+<code javascript>
 /**
@@ Строка 64: / Строка 61: @@
 Затем выполните следующую команду в текущем каталоге:
-<code>
+<code javascript>
 jsdoc doc.js
 </code>
-Наконец, файл с именем''out'' Содержимое текущего каталога станет следующим:
+Наконец, файл с именем ''out'' Содержимое текущего каталога станет следующим:
-<code>
+<code javascript>
 ├── doc.js
 └── out
@@ Строка 109: / Строка 106: @@
-Посетите это через браузер''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам;
+Посетите это через браузер ''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам;
 Домашняя страница:
+{{:nodejs:7a790d6680b04ece105b4d5c9c17efb5.png|}}
+Укажите страницу функции:
-{{:images:741:7a790d6680b04ece105b4d5c9c17efb5.png|jsdoc-home.png}}Укажите страницу функции:
+{{:nodejs:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|}}
-{{:images:624:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|jsdoc-func.png}}\\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев;
+\\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев;
 ==== Формат комментария ====
@@ Строка 125: / Строка 125: @@
 JSDoc использует следующий формат символов комментария для обертывания тегов, которые будут добавлены на уровне блока:
-<code>
+<code javascript>
 /**
  *
@@ Строка 135: / Строка 135: @@
 То есть столбец звездочки выровнен по вертикали. Используйте две звездочки в первой строке и добавьте пробел после каждой звездочки перед записью содержимого, например:
-<code>
+<code javascript>
 /**
    * Оставьте пробел перед описанием
@@ Строка 145: / Строка 145: @@
 Встроенный пакет:
-<code>
+<code javascript>
 /** @function */
 </code>
@@ Строка 154: / Строка 154: @@
 Также можно написать''@desc'', Чтобы описать подробную информацию о текущем объекте аннотации;
-<code>
+<code javascript>
 /**
  * @function
@@ Строка 172: / Строка 172: @@
 === @file ===
-''Комментарий записывается в начале файла, чтобы описать соответствующую информацию о текущем файле; например:''
+Комментарий записывается в начале файла, чтобы описать соответствующую информацию о текущем файле; например:
-<code>
+<code javascript>
 /**
    * @file Это файл для ..., содержит ... функции
@@ Строка 185: / Строка 185: @@
 === @author ===
-''Опишите соответствующую информацию об авторе текущего файла или кода;''
+Опишите соответствующую информацию об авторе текущего файла или кода;
-<code>
+<code javascript>
 /**
  * @author Jack <jack@example.com>
@@ Строка 196: / Строка 196: @@
 === @copyright ===
-''Опишите информацию об авторских правах текущего файла''
+Опишите информацию об авторских правах текущего файла
-<code>
+<code javascript>
 /**
  * @copyright Jack 2020
@@ Строка 207: / Строка 207: @@
 === @license ===
-''Опишите информацию, относящуюся к текущей лицензии на файл;''
+Опишите информацию, относящуюся к текущей лицензии на файл;
-<code>
+<code javascript>
 /**
  * @license MIT
@@ Строка 219: / Строка 219: @@
 или:
-<code>
+<code javascript>
 /**
  * @license
@@ Строка 240: / Строка 240: @@
 Опишите номер версии текущего проекта;
-<code>
+<code javascript>
 /**
    * Эта версия исправляет ... проблемы
@@ Строка 253: / Строка 253: @@
 Опишите, в какой версии была введена функция;
-<code>
+<code javascript>
 /**
  * Обеспечить ... функцию
@@ Строка 267: / Строка 267: @@
 Подобно значениям «см. Также» и «см. Подробно», вы также можете использовать его для навигации в другие места.''@link'' Перейти к определенному сетевому адресу;
-<code>
+<code javascript>
 /**
  * @see fn2
@@ Строка 284: / Строка 284: @@
 Опишите, что делать дальше;
-<code>
+<code javascript>
 /**
    * @todo add ... функция
@@ Строка 297: / Строка 297: @@
 против ''@func'', ''@method'' То же самое означает описание функции;
-<code>
+<code javascript>
 /** @function */
 var myFn = function() {}
@@ Строка 308: / Строка 308: @@
 Опишите тип переменной;
-<code>
+<code javascript>
 /**
    * Переменная типа объекта
@@ Строка 370: / Строка 370: @@
 против ''@arg'', ''@argument'' То же самое означает описание информации о параметрах функции;
-<code>
+<code javascript>
 /**
    * За меткой следует тип параметра, затем имя параметра и, наконец, описание параметра.
@@ Строка 444: / Строка 444: @@
 === @typedef ===
-''Используется для описания типов пользовательских переменных;''
+Используется для описания типов пользовательских переменных;
-<code>
+<code javascript>
 /**
    * Описание нестандартного типа
@@ Строка 462: / Строка 462: @@
 === @callback ===
-''Опишите информацию о параметрах указанной функции как функцию обратного вызова;''
+Опишите информацию о параметрах указанной функции как функцию обратного вызова;
-<code>
+<code javascript>
 /**
    * Это описание функции обратного вызова
@@ Строка 482: / Строка 482: @@
 === @returns ===
-Или напишите''@return'', Информация, описывающая возвращаемое значение функции;
+Или напишите ''@return'', Информация, описывающая возвращаемое значение функции;
-<code>
+<code javascript>
 /**
  * @param {number} a
@@ Строка 508: / Строка 508: @@
 === @example ===
-''Опишите пример использования указанного кода;''
+Опишите пример использования указанного кода;
-<code>
+<code javascript>
 /**
    * Добавьте образец кода (формат будет выделен)
@@ Строка 529: / Строка 529: @@
 === @class ===
-Опишите''class'' учебный класс;
+Опишите ''class'' учебный класс;
-<code>
+<code javascript>
 /**
    * Описание категории
@@ Строка 548: / Строка 548: @@
 === @namespace ===
-''Опишите пространство имен;''
+Опишите пространство имен;
-<code>
+<code javascript>
 /**
    * Укажите объект в пространстве имен
@@ Строка 584: / Строка 584: @@
 === @member ===
-''Описать член текущего класса;''
+Описать член текущего класса;
-<code>
+<code javascript>
 /**
  * @class
@@ Строка 605: / Строка 605: @@
 Опишите класс, к которому принадлежит член;
-<code>
+<code javascript>
 /**
  * @class

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

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

Различия

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