Инструменты пользователя
nodejs:jsdoc
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
nodejs:jsdoc [2022/05/13 10:34] werwolf |
nodejs:jsdoc [2023/01/12 12:18] (текущий) |
||
|---|---|---|---|
| Строка 30: | Строка 30: | ||
| Пользоваться инструментом очень просто, сначала установите его: | Пользоваться инструментом очень просто, сначала установите его: | ||
| - | <code javascript> | + | <code powershell> |
| npm install -g jsdoc | npm install -g jsdoc | ||
| </code> | </code> | ||
| - | Во-вторых, предположим, что в''doc.js'' Напишите в файл следующий код: | + | Во-вторых, предположим, что в ''doc.js'' Напишите в файл следующий код: |
| <code javascript> | <code javascript> | ||
| Строка 66: | Строка 66: | ||
| - | Наконец, файл с именем''out'' Содержимое текущего каталога станет следующим: | + | Наконец, файл с именем ''out'' Содержимое текущего каталога станет следующим: |
| <code javascript> | <code javascript> | ||
| Строка 106: | Строка 106: | ||
| - | Посетите это через браузер''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам; | + | Посетите это через браузер ''out'' Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам; |
| Домашняя страница: | Домашняя страница: | ||
| + | {{:nodejs:7a790d6680b04ece105b4d5c9c17efb5.png|}} | ||
| + | |||
| + | Укажите страницу функции: | ||
| - | {{:images:741:7a790d6680b04ece105b4d5c9c17efb5.png|jsdoc-home.png}}Укажите страницу функции: | + | {{:nodejs:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|}} |
| - | {{:images:624:17f2a89fe89a9f5ff6fcb0c5a4d43b88.png|jsdoc-func.png}}\\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев; | + | \\ Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев; |
| ==== Формат комментария ==== | ==== Формат комментария ==== | ||
| Строка 441: | Строка 444: | ||
| === @typedef === | === @typedef === | ||
| - | ''Используется для описания типов пользовательских переменных;'' | + | Используется для описания типов пользовательских переменных; |
| <code javascript> | <code javascript> | ||
| Строка 479: | Строка 482: | ||
| === @returns === | === @returns === | ||
| - | Или напишите''@return'', Информация, описывающая возвращаемое значение функции; | + | Или напишите ''@return'', Информация, описывающая возвращаемое значение функции; |
| <code javascript> | <code javascript> | ||
| Строка 526: | Строка 529: | ||
| === @class === | === @class === | ||
| - | Опишите''class'' учебный класс; | + | Опишите ''class'' учебный класс; |
| <code javascript> | <code javascript> | ||
nodejs/jsdoc.1652427252.txt.gz · Последние изменения: 2023/01/12 12:17 (внешнее изменение)
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
