Тема: Тип *
Показать сообщение отдельно
Старый 07.04.2009, 00:18
wvxvw вне форума Посмотреть профиль Отправить личное сообщение для wvxvw Найти все сообщения от wvxvw
  № 22  
Ответить с цитированием
wvxvw
Modus ponens
 
Аватар для wvxvw

модератор форума
Регистрация: Jul 2006
Адрес: #1=(list #1#)
Сообщений: 8,049
Записей в блоге: 38
Любая public / protected функция должна быть прокоментирована (internal - очень желательно), не важно, что вам кажется, что название все объясняет. За примером вообще далеко ходить не надо - во Флексовом фреймворке компонент проходит несколько стадий в процесе инициализации - никто вам не гарантирует, что функция типа initGame будет всего одна, что не глядя в тело функции вы всегда наверняка сможете сказать, а что именно она делает. Опять же, такой подход вызван тем, что вы ориентируетесь на плохую среду разработки, в которой коментарии ни на что не влияют. Мне, например, коментрарии нужны для того, чтобы не открывая код, в тултипе увидеть что делает функция, потому, что если я открою одновременно несколько сотен файлов проекта и буду метаться от одного к другому для того, чтобы понять, что происходит в том месте, где я сейчас работаю - я так за неделю с трудом 1-2К строк напишу... да и то если...

И да, не исключен вариант, что именно из-за такой вот ерунды будут дергать - потому что это выглядит как ошибка. И когда вам оставляют проект на 100+ классов, и нужно поправить какой-то баг, происхождение которого вам непонятно - такие вещи в первую очердь в глаза бросются. Потому что, опять же никакой нормальный человек не будет сравнивать булевые величины, поэтому, первая реакция на такую "конструкцию" - "а наверное в запарке тут чего-то не то влепил"... а может это должен быть "true", а не true, а может с копипастом промахнулся... и т.п.
__________________
Hell is the possibility of sanity