Читайте также:
|
Платформа 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. Такие части, как правило, должны состоять из одного единственного слова или сокращения.
Многие пакеты имеют имена, в которых, помимо названия домена в Интернете, присутствует только одно слово. Большее количество частей в имени пакета нужно лишь для больших систем, чей размер настолько велик, что требует создания неформальной иерархии. Например, в пакете jаvах.swing представлена сложная иерархия пакетов с такими названиями, как jаvах.swing.plaf.metal. Подобные пакеты часто называют подпакетами, однако это относится исключительно к области соглашений, поскольку для иерархии пакетов нет лингвистической поддержки.
Названия классов и интерфейсов состоят из одного или нескольких слов, причем в каждом слове первая буква должна быть заглавной, например Тiтer или ТimerTask. Необходимо избегать аббревиатур, за исключением акронимов и нескольких общепринятых сокращений, таких как mах и min. Нет полного единодушия по поводу того, должны ли акронимы полностью писаться прописными буквами или же заглавной у них должна быть только первая буква. Хотя чаще в верхнем регистре пишется все название, есть один сильный аргумент в пользу того, чтобы заглавной была только первая буква. В последнем случае всегда ясно, где кончается одно слово и начинается другое, даже если рядом стоят несколько акронимов. Какое название класса вы предпочли бы увидеть: НTTРURL или HttpUrl?
Названия методов и полей подчиняются тем же самым типографским соглашениям, за исключением того, что первый символ в названии всегда должен быть строчным, например remove, ensureCapacity. Если первым словом в названии метода или поля оказывается акроним, он весь пишется строчными буквами.
Единственное исключение из предыдущего правила касается "полей-констант" (constant field), названия которых должны состоять из одного или нескольких слов, написанных заглавными буквами и отделенных друг от друга символом подчеркивания, например VALUES или NEGAТIVE_INFINIТY. Поле-константа - это поле static final, значение которого не меняется. Если поле static final имеет простой тип или неизменяемый ссылочный тип (статья 13), то это поле-константа. Даже если тип поля относится к потенциально изменяемым, это все равно может быть поле-константа при условии, что объект, на который оно ссылается, является неизменяемым. Например, перечисление типов может представить пространство своих перечислимых констант в виде неизменяемой константы типа List (статья 21). Заметим, что поля-константы единственное место, где допустимо использование символа подчеркивания.
Названия локальных переменных подчиняются тем же типографским соглашениям, что и названия членов классов, за исключением того, что в них можно использовать аббревиатуры, отдельные символы, а также короткие последовательности символов, смысл которых зависит от того контекста, где эти локальные переменные находятся. Например: i, xref, houseNumber. Примеры типографских соглашений приведены в таблице 7.1.
По сравнению с типографскими, грамматические соглашения, касающиеся именования, более гибкие и спорные. Для пакетов практически нет грамматических соглашений. для именования классов обычно используются существительные или именные конструкции, например Timer и BufferedWriter. Интерфейсы именуются так же,
как классы, например Collect1on и Comparator, либо применяются названия с окончаниями, образованными от прилагательных "-able" и "-ible", например Runnable и Accessible.
Дата добавления: 2015-09-11; просмотров: 74 | Поможем написать вашу работу | Нарушение авторских прав |