Re[3]: Комментарии к коду
От: Abyx Россия  
Дата: 11.04.11 15:59
Оценка:
Здравствуйте, BSDыщъх, Вы писали:

BSD>Здравствуйте, Abyx, Вы писали:


BSD>По имени функции adjustЧтоТоТам не понятно, модифицирует она это ЧтоТо или только вычисляет подходящий размер. Чтобы это понять нужно погрузиться в реализацию.

достаточно навести на нее курсор и увидеть сигнатуру — там нет out-параметров
что характерно, чтобы увидеть комментарий надо сделать тоже самое

BSD>Но проблема в том что у автора кода и у модификатора никогда не будет на 100% совпадающего словаря. Что для одного кажется очевидным наименованием, для другого непонятным. То же и про багаж знаний. Любой специалист может не знать какой-нибудь модной мелочи, которая автору кажется очевидной.

BSD>Или имя выбрано вроде бы удачно, но может вдруг вызвать аллюзию к другой предметной области.
После некоторого времени можно понять какой именно словарь используется в коде. Тогда будет понятно, что theta это угол а не, скажем, температура.
Вместо того чтобы расписывать словарь в коде, лучше сделать отдельную документацию (wiki например).
In Zen We Trust
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.