При выборе имен придерживайтесь общепринятых соглашений

Платформа Java обладает хорошо устоявшимся набором соглашений, касающихся выбора имен (naming convention). Многие из них приведены в The Jаvа Lаngиаgе Sресifi:аtiоп [JLS, 6.8]. Соглашения об именовании делятся на две ка-r:егории: типографские и грамматические.

Типографских соглашений, касающихся выбора имен для пакетов, классов, интерфейсов и полей, очень мало. Никогда не нарушайте их, не имея на то веской причины. API, не соблюдающий эти соглашения, будет трудно использовать. Если соглашения нарушены в реализации, ее будет сложно сопровождать. В обоих случаях нарушение соглашений может запутывать и раздражать других программистов, работающих с этим кодом, а также способствовать появлению ложных допущений, приводящих к ошибкам.

Названия пакетов должны представлять собой иерархию, отдельные части которой отделены друг от друга точкой. Эти части должны состоять из строчных букв и изредка цифр. Название любого пакета, который будет использоваться за пределами организации, обязано начинаться с доменного имени вашей организации в Интернете, которому предшествуют домены верхнего уровня, например edu. cmu, com.sun, gov.nsa. Исключение из этого правила составляют стандартные библиотеки, а также необязательные пакеты, чьи названия начинаются со слов jаvа и jаvах. Пользователи не должны создавать пакетов с именами, начинающимися с jаvа или jаvах. Детальное описание правил, касающихся преобразования названий доменов Интернета в префиксы названий пакетов, можно найти в The Jаvа Langиage Sресifсаtiоп [JLS, 7.7].

Вторая половина в названии пакета должна состоять из одной или нескольких частей, описывающих этот пакет. Части должны быть короткими, обычно не длиннее восьми символов. Поощряются выразительные сокращения, например util вместо utilities. Допустимы акронимы, например awt. Такие части, как правило, должны состоять из одного единственного слова или сокращения.

\


Читать еще…

Понравилась статья? Поделиться с друзьями: