Новости | FAQ | Авторы | Документация | В действии | Библиотека |
Инструменты | Полезные ссылки | Хостинги | Скачать | Примеры | Форум |
Misha v.3 04.10.2005 14:24
Когда я был молодой, то меня учили документировать код.посностью согласен, но вы пишите код на парсере. код, который в общем случае не должен быть предназначен для тех, кто в глаза не видел его. т.е. человек, который его будет читать знает его.
# Если входной hash определен...есть бред. из базового оператора понятно что он делает, и подобные комментарии только усложняют жизнь.
^if(def $arrHash){
# @debugShowObject[] Визуализация объектовте-же яйца, только в профиль. ваш файл с методами/класс предназначен для визуализации объектов. писать масло масляное совершенно незачем. на самом деле избыточные комментарии не только усложняют чтение кода, они ещё и вводят в заблуждение, т.к. авторы вынуждены править и их при изменениях, о чем они частенько забывают (особенно когда комментариев миллион), в результате оказывается что комментарий не соотвествует действительности.