JSDoc

Начало работы

Начало работы с JSDoc 3

Быстрый старт по документированию JavaScript с помощью JSDoc.

Использование namepaths с JSDoc 3

Руководство по использованию namepaths с JSDoc 3.

Аргументы командной строки для JSDoc

Об аргументах командной строки для JSDoc.

Настройка JSDoc с помощью файла конфигурации

Как настроить JSDoc с помощью файла конфигурации.

Настройка шаблона по умолчанию JSDoc

Как настроить вывод от шаблона по умолчанию JSDoc.

Блочные и встроенные теги

Обзор блочных и встроенных тегов JSDoc.

О плагинах JSDoc

Как создавать и использовать плагины JSDoc.

Использование плагина Markdown

Включить поддержку Markdown в JSDoc.

Учебники

Добавление учебников в вашу документацию API.

Включение файла пакета

Как отобразить сведения о пакете в вашей документации.

Включение файла README

Как включить файл README в вашу документацию.

Лицензия

Сведения о лицензии для JSDoc 3.

Примеры JSDoc

Классы ES 2015

Как добавлять комментарии JSDoc к классам ECMAScript 2015.

Модули ES 2015

Как добавлять комментарии JSDoc к модулям ECMAScript 2015.

Модули CommonJS

Как добавлять комментарии JSDoc к модулям CommonJS и Node.js.

Модули AMD

Как добавлять комментарии JSDoc к модулям AMD и RequireJS.

Блочные теги

@abstract (синонимы: @virtual)

Этот член должен быть реализован (или переопределен) наследником.

@access

Укажите уровень доступа к этому члену (private, package-private, public или protected).

@alias

Обращаться к члену как к члену с другим именем.

@async

Указывает, что функция является асинхронной.

@augments (синонимы: @extends)

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

@author

Определяет автора элемента.

@borrows

Этот объект использует что-то из другого объекта.

@callback

Документировать функцию обратного вызова.

@class (синонимы: @constructor)

Эта функция предназначена для вызова с ключевым словом "new".

@classdesc

Используйте следующий текст для описания всего класса.

@constant (синонимы: @const)

Документировать объект как константу.

@constructs

Этот член функции будет конструктором для предыдущего класса.

@copyright

Документировать какую-либо информацию об авторском праве.

@default (синонимы: @defaultvalue)

Документировать значение по умолчанию.

@deprecated

Документировать, что это больше не предпочтительный способ.

@description (синонимы: @desc)

Описать символ.

@enum

Документировать набор связанных свойств.

@event

Документировать событие.

@example

Привести пример использования документированного элемента.

@exports

Определите член, который экспортируется JavaScript-модулем.

@external (синонимы: @host)

Определяет внешний класс, пространство имён или модуль.

@file (синонимы: @fileoverview, @overview)

Описать файл.

@fires (синонимы: @emits)

Описать события, которые может генерировать этот метод.

@function (синонимы: @func, @method)

Описать функцию или метод.

@generator

Указывает, что функция является генераторной функцией.

@global

Документировать глобальный объект.

@hideconstructor

Указывает, что конструктор не должен отображаться.

@ignore

Исключить символ из документации.

@implements

Этот символ реализует интерфейс.

@inheritdoc

Указывает, что символ должен унаследовать документацию родителя.

@inner

Документировать внутренний объект.

@instance

Документировать член экземпляра.

@interface

Этот символ является интерфейсом, который другие могут реализовать.

@kind

Какой тип символа это?

@lends

Документировать свойства в объекте литерала, как если бы они принадлежали символу с заданным именем.

@license

Определите лицензию, которая применяется к этому коду.

@listens

Перечислите события, на которые подписывается символ.

@member (синонимы: @var)

Документировать член.

@memberof

Этот символ принадлежит родительскому символу.

@mixes

Этот объект объединяет все члены из другого объекта.

@mixin

Документировать объект миксин.

@module

Документировать JavaScript-модуль.

@name

Документировать имя объекта.

@namespace

Документировать объект пространства имён.

@override

Указывает, что символ переопределяет родительский.

@package

Этот символ предназначен для внутреннего использования пакета.

@param (синонимы: @arg, @argument)

Документировать параметр функции.

@private

Этот символ предназначен для внутреннего использования.

@property (синонимы: @prop)

Документировать свойство объекта.

@protected

Этот символ предназначен для защищённого использования.

@public

Этот символ предназначен для общего использования.

@readonly

Этот символ предназначен для только для чтения.

@requires

Этот файл требует JavaScript-модуль.

@returns (синонимы: @return)

Документировать возвращаемое значение функции.

@see

Обратитесь к другой документации для получения дополнительной информации.

@since

Когда эта функция была добавлена?

@static

Документировать статический член.

@summary

Более короткая версия полного описания.

@this

Что обозначает ключевое слово 'this' здесь?

@throws (синонимы: @exception)

Опишите, какие ошибки могут быть выброшены.

@todo

Документировать задачи, которые должны быть выполнены.

@tutorial

Вставить ссылку на включённый файл учебника.

@type

Документировать тип объекта.

@typedef

Документировать пользовательский тип.

@variation

Различать разные объекты с одинаковым именем.

@version

Документирует номер версии элемента.

@yields (синонимы: @yield)

Документировать значение, возвращаемое генераторной функцией.

Встроенные теги

{@link} (синонимы: {@linkcode}, {@linkplain})

Ссылка на другой элемент в документации.

{@tutorial}

Ссылка на учебник.

Участие

Проект JSDoc на GitHub

Участвуйте в проекте JSDoc.

Используйте проект JSDoc на GitHub

Участвуйте в документировании JSDoc.

Развилка на GitHub