Выберите одно слово для каждой концепции

Выберите одно слово для представления одной абстрактной концепции и придерживаетесь его. Например, существование в разных классах эквивалентных методов с именами fetch, retrieve и get неизбежно создаст путаницу. Как запомнить, какой термин использовался в той или иной библиотеке или классе, нередко приходится помнить, какой компанией, группой или программистом эта библиотека была создана. В противном случае вы потратите массу времени на просмотр заголовков и предыдущих примеров кода.Современные рабочие среды типа Eclipse предоставляют контекстно-зависимые подсказки — скажем, список методов, которые могут вызываться для конкретного обьекта. Однако следует учитывать, что в этом списке обычно не приводятся комментарии, которые вы записываете рядом с именами функции и списками параметров. И вам еще повезло, если в нем будут указаны имена параметров из обьявлении функций. Имена функций должны быть законченными и логичными, чтобы программист мог сразу выбрать правильный метод без сбора дополнительной информации.

Аналогичным образом, использование терминов controller, manager и driver в одной кодовой базе тоже вызывает путаницу.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *