JSDoc — генератор документации в HTML-формате из комментариев исходного кода на JavaScript. Синтаксис JSDoc похож на синтаксис Javadoc, который используется для документирования Java кода, но предназначен для работы с языком JavaScript, который является более динамичным, и поэтому JSDoc не совместим с Javadoc. Как и Javadoc, JSDoc позволяет программисту создавать доклеты и теги, которые могут быть выведены в файл, например HTML или RTF.
Пример
Пример использования JSDoc. /** * Создает экземпляр Circle. * * @constructor * @this {Circle} * @param {number} r - Радиус окружности. */ function Circle® { /** @private */ this.radius = r;
/** * Создает новый экземпляр Circle по диаметру. * * @param {number} d - Диаметр окружности. * @return {Circle} Новый объект Circle. * * @static */ Circle.fromDiameter = function (d) { return new Circle(d / 2); };
/** * Подсчитывает длину окружности * * @deprecated * @this {Circle} * @return {number} Длина окружности. */ Circle.prototype.calculateCircumference = function () { return 2 * Math.PI * this.radius; };
/** * Возвращает длину окружности, вычисленную заранее. * * @this {Circle} * @return {number} Длина окружности. */ Circle.prototype.getCircumference = function () { return this.circumference; };
/** * Строковое представление объекта Circle. * * @override * @this {Circle} * @return {string} Информация об объекте Circle. */ Circle.prototype.toString = function () { return "A Circle object with radius of " + this.radius + "."; };
