Показать сообщение отдельно
Старый 27.10.2004, 16:28   #24  
Alks is offline
Alks
Участник
 
336 / 41 (2) +++
Регистрация: 23.07.2004
Адрес: г. Новокузнецк
Цитата:
Изначально опубликовано George Nordic
http://w8.platonoff.com/refactoring/

Рефакторинг! Утонем в комментариях. Код - это и есть в данном случае комментарий + грамотное название методов и классов...
Другое дело, что в паре мест они действительно не помешеют...
Другое дело что в аксапте я мало чего вижу в строках кода от комментариев.
Например алгоритме и логике работы PriceDisc разбирался полдня, прежде чем выжатый как лимон уяснил для себя таки все "важные, но неявные" моменты...
Отсутвие комментариев - зло. Без всяких исключений. Другое дело что не все умеют писать комментарии, хотя от засорения программы фишками типа
PHP код:
// прирастим переменную i на единицу
i++; 
остерегают даже самые неудачные книжки по программированию.
На самом деле хороший комментарий не должен комментировать код (вернее почти не должен - везде есть исключения, иногда нестандартный приём в коде должен быть прокомментирован, чтобы не сбить с толку, но как правильно говорится в принципах рефакторинга код по возможности не должен содержать таких неочевидных/нестандартных моментов), комментарий должен комментировать ИДЕЮ. КАК МИНИМУМ должен быть прокомментирован каждый класс (в classDeclaration прописана сущность класса, его предназначение, место в иерархии классов) и каждый метод (тоже в целом - сущность метода, его параметры, возвращаемое значение, возможные побочные эффекты).
Учтивывайте то, что даже программист разрабатывавший код самолично через пару месяцев уже не узнаёт ни строчки из своего кода - тут уже степень закомментированности программы становится просто показателем эффективности труда, я уже не говорю про то что смена или привлечение нового программиста просто катастрофически затруднена если нет хоть какой то документации.