Интернет магазин китайских планшетных компьютеров



Компьютеры - JSDoc - Пример

01 мая 2011


Оглавление:
1. JSDoc
2. Пример
3. История



Пример использования JSDoc.

/**
 * Создает экземпляр Circle.
 *
 * @constructor
 * @this {Circle}
 * @param {number} r Радиус окружности.
 */
function Circle {
    /** @private */ this.radius = r;
    /** @private */ this.circumference = 2 * Math.PI * r;
}
 
/**
 * Создает новый экземпляр Circle по диаметру.
 *
 * @param {number} d Диаметр окружности.
 * @return {Circle} Новый объект Circle.
 */
Circle.fromDiameter = function  {
    return new Circle;
};
 
/**
 * Подсчитывает длину окружности
 *
 * @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 + ".";
};


Просмотров: 2864


<<< Haml
Markdown >>>