Показать сообщение отдельно
Старый 08.09.2012, 12:32
expl вне форума Посмотреть профиль Отправить личное сообщение для expl Найти все сообщения от expl
  № 7  
Ответить с цитированием
expl

блогер
Регистрация: Feb 2006
Сообщений: 1,474
Записей в блоге: 3
Я бы так не сказал, например реально видел такое:
Код AS3:
// Счетчик количества
public var count:int;
 
// Пока что пустой конструктор
public function NameOfClassIsForgiven()
{
}
Вот сразу:
-Чего счетчик, какого количества?
-А чё, без каммента я подумаю что это не конструктор? И не пустой? И это на что-то повлияет?

Самое смешое что такой код без камментов гораздо понятнее и больше говорит о себе:
Код AS3:
public var appleCount:int;
 
public function NameOfClassIsForgiven()
{
}
java-доки - это отдельная тема. Когда некоторые open-source либы смотришь - там кроме Кепа эти комменты для генерации доков никто не пишет, может даже их не человек, а скрипт добавляет.

Основное правило тут не "больше комментируйте", а их тут 2:
- если код можно изменить, чтобы комменты были не нужны - лучше изменить код
- комментируйте не _что_ вы делаете, а _зачем_ Вы это делаете, т.е. не надо комментариев "это мост" - я и так вижу что это мост, расскажите куда он ведёт и почему без него никак.

Цитата:
А ещё у меня скоро день рождения
В одном коллективе так реально писали в коде телефоны и адреса в комментах - вместо записной книжки.
Мотивировалось это тем, что код хранится в репозитории и ценная информация не потеряется.


Последний раз редактировалось expl; 08.09.2012 в 12:53.