MyTetra Share
Делитесь знаниями!
Документирование JS-функций через JSDoc
25.05.2019
21:22
Автор: br0ke
Текстовые метки: javascript, js, ecmascript, ecma, es, jsdoc, documentation, param, type, docstring
Раздел: Информационные технологии - JavaScript

В JS можно документировать функции в широко распространённом формате JSDoc. На основе таких комментариев позднее можно сгенерировать документацию в HTML или PDF. Пример:


/**

* Represents a book.

* @constructor

* @param {string} title - The title of the book.

* @param {string} author - The author of the book.

*/

function Book(title, author) {

}


В JSDoc используются следующие тэги:



Тег

Описание

@author

Имя разработчика

@constructor

Маркирует функцию как конструктор

@deprecated

Маркирует метод устаревшим и не рекомендуемым

@exception

Синоним для @throws

@param

Описывает аргумент функции; можно указать тип, задав его в фигурных скобках

@private

Означает, что метод приватный

@return

Описывает возвращаемое значение

@returns

Синоним return

@see

Описывает связь с другим объектом

@this

Задает тип объекта, на который указывает ключевое слово «this» внутри функции.

@throws

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

@version

Версия библиотеки


Описание параметров/аргументов функций производится при помощи тэга @param имя тип описание.


  • В качестве типа могут быть использованы следующие значения: базовые типы данных JS -- boolean, number, string, Object, либо имена классов, определенных в коде.
  • Можно объединять типы: {(number|boolean)}
  • Можно описывать массивы: {number[]} или {Array.<number>}
  • Nullable-тип: {?number}
  • Non-nullable-тип: {!number}
  • Неизвестное заранее количество аргументов: {...number}
  • Опциональный параметр: @param {number} [foo] или @param {number=} foo



Так же в этом разделе:
 
MyTetra Share v.0.52
Яндекс индекс цитирования