Содержание


Соглашения об именах Java

Облегчите себе жизнь

Comments

Используйте полные дескрипторы, точно описывающие переменную, поле или класс.

Развить навыки по этой теме

Этот материал — часть knowledge path для развития ваших навыков. Смотри Стать Java-программистом

Например, используйте такие имена, как firstName, grandTotal или CorporateCustomer. Хотя короткие имена типа x1, y1 или fn легко набирать, они не о чем не говорят, поэтому код получится трудным для понимания, поддержки и дальнейшего развития.

Используйте терминологию предметной области.

Если ваши пользователи называют своих клиентов customers, используйте для класса термин Customer, а не Client. Многие разработчики допускают ошибку, изобретая новые названия для тех понятий, для которых уже существуют термины, общепринятые в данной предметной области.

Используйте смешанный регистр, чтобы сделать имена читабельными.

В целом нужно использовать строчные буквы, но имена классов и интерфейсов, а также все слова, кроме первого, пишите с прописной.

Аббревиатуры используйте скупо и рационально.

Это означает, что нужно вести список стандартных сокращений, выбирать их разумно и использовать последовательно. Например, если вы хотите использовать краткую форму number, то выберите nbr, no или num, запишите это сокращение (неважно, какое) и используйте только его.

Избегайте длинных имен (лучше не превышать 15 символов).

Имя класса PhysicalOrVirtualProductOrService в какой-то момент может показаться удачным, но оно слишком длинное, и его надо как-то сократить – возможно, что-то вроде Offering.

Избегайте имен, которые слишком похожи или различаются только регистром.

Имена переменных persistentObject и persistentObjects нельзя использовать вместе, как и имена anSqlDatabase и anSQLDatabase.

Пишите стандартные акронимы строчными буквами с прописной.

Имена часто содержат стандартные аббревиатуры, такие как SQL (Standard Query Language). Имена типа sqlDatabase для атрибута или SqlDatabase для класса легче читать, чем sQLDatabase и SQLDatabase.


Ресурсы для скачивания


Похожие темы


Комментарии

Войдите или зарегистрируйтесь для того чтобы оставлять комментарии или подписаться на них.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=40
Zone=SOA и web-сервисы
ArticleID=845108
ArticleTitle=Соглашения об именах Java
publish-date=11092012