Re[4]: Как приучить пользователей использовать поиск?
От: мыщъх США http://nezumi-lab.org
Дата: 08.05.12 01:34
Оценка:
Здравствуйте, Философ, Вы писали:

Ф>Здравствуйте, мыщъх, Вы писали:


М>>а потому даю функциям короткие и четкие имена

Ф>а я иногда за весь день имя придумать не могу,
я иногда неделями думаю над именами (без преувеличений). а то и месяцами. последнее время читаю много чужого кода на разных языках (особенно на тех, которые не понимаю). если суть ясна из имен функций/методов/классов -- то я перенимаю успешный опыт. после этого программу можно читать как новеллу.

кстати, это радикально меняет стиль программирования. если вы не можете дать функции короткое имя, то, вероятно, это неправильная функция и в ней смешаны разные сущности и по хорошему их нужно растащить по разным фунциям.

кстати, в результате такого стиля при копи-пасте (ну куда же без нее) не приходится переименовать переменные. типа из одной функции выдернули кусок кода и воткнули в другую. и она "подхватила" все переменные. автоматом.

> а потому иногда плюю на это дело и складывают 3 — 5 слов, описывающих суть происходящего.

можно пример функции из пяти слов? просто интересно...

Ф>притом, чаще всего, в комментариях которые я пишу проясняется 2 вещи:

Ф>0) что этот метод делает
ох, как же ненавижу я такие комментарии (хотя ими тоже грешу). у меня последнее время в комментариях или фрагменты спецификаций, например:
// A zlib stream has the following structure:
// 0 1
// +---+---+ +=====================+---+---+---+---+
// |CMF|FLG| (more-->) |...compressed data...| ADLER32 |
// +---+---+ +=====================+---+---+---+---+

или же "руками не трогать, это не баг, это для совместимости со старой версией" или "парсим xml руками потому что эти кретины присылают нам файлы ни фига не по спецификации и библиотечные парсеры работают с вероятностью 50 на 50 в зависимости от того будут ли в xml недопустимые по спецификации символы". так что такой комментарий комментирует не код и даже не что этот код делает (и так понятно из назввания, что парсит xml), а _почему_ этот код здесь. согласитесь, что без подобного комментария вы запросто можете пожать плечами (какой студент это писал?) выкинуть пару сотен строк кода и заменить ее одним библиотечным вызовом. и программа будет работать. какое время... и если третья сторона успеет пофиксить баг в экпорте xml, то есть шансы, что все будет шоколадно, но... а если не успеет? вот тут и нужно оставить коммент на этот случай, что мы парсим xml руками, потому что обнаружили, что наши поставщики поставляют то, что сносит крышу библиотечным парсерам.




Ф>1) зачем (почему) он нужен
americans fought a war for a freedom. another one to end slavery. so, what do some of them choose to do with their freedom? become slaves.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.