JSDoc

Матеріал з Вікіпедії — вільної енциклопедії.
Перейти до: навігація, пошук

JSDoc — це інструмент для документування JavaScript коду. За твердженням ідеолога програмування Дональда Кнута, програмний код і документація до нього повинні складати одне ціле. Ця парадигма документування та написання програмного коду деякою мірою реалізована в JSDoc.

Походження[ред.ред. код]

JSDoc походить від дуже успішного інструменту JDoc, (по суті JSDoc є його адаптацією для JavaScript)

Синтаксис[ред.ред. код]

Частина, що відноситься до JSDoc документації зазвичай заключаються в контейнер, який починається з символів /** та закінчується */.

Теги[ред.ред. код]

Тег Опис
@author Ім'я розробника.
@constructor Позначає функцію як конструктор.
@param Документування параметру.
@return Документування результату, що повертає функція.
@see Документування асоціації з іншим об'єктом.
@version Вказує номер версії бібліотеки.

Приклад використання[ред.ред. код]

 /**
  * Create an instance of Circle.
  * 
  * @constructor
  * @param {number} r The desired radius of the circle.
  */
  function Circle(r) {
  }

Дивись також[ред.ред. код]