Как комментировать функции?
Мне кажется лучше делать так
//Отправляет сообщение
function sendMessage(){
}
//Отправить сообщение
sendMessage();
А как комментируете вы? |
Цитата:
// Делает то-то
function primer(Val1,Val2,...,ValN){
/*
Val1 - означает то-то
Val2 - означает то-то
...
ValN - означает то-то
*/
}
// Сделать то-то
<последовательность_действий>;
|
/**
* Создает экземпляр Circle.
*
* @constructor
* @this {Circle}
* @param {number} r Радиус окружности.
*/
function Circle(r) {
/** @private */ this.radius = r;
/** @private */ this.circumference = 2 * Math.PI * r;
}
/**
* Создает новый экземпляр Circle по диаметру.
*
* @param {number} d Диаметр окружности.
* @return {Circle} Новый объект Circle.
*/
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 + ".";
};
|
danik.js, интересно... Зачем * на каждой строке?
Теперь ведь почти каждый редактор подсвечивает коментарии... Т.е. их и так видно. |
|
Цитата:
|
Цитата:
|
Коментирую только методы и очень неочевидные блоки. Остальное как сказано выше:
Цитата:
|
Комментирую все функции по стандарту JSDoc GCC. Профит в том, что потом можно юзать GCC как валидатор коду + проще юзать advanced mode, а также по таким комментам легко делать генерацию доки в HTML.
Некоторые IDE, например WebStorm, умеют использовать такие доки для "умного" автокомплита, т.е. также как и у типизированных языков без необходимости подключения специальных библиотек. |
Цитата:
Цитата:
Цитата:
|
| Часовой пояс GMT +3, время: 04:48. |