26 апр. 2011 г.

Основы Java: имена переменных и методов

Начнем серию статей, посвященных основам Java, с правил и рекомендаций, которые предлагает нам Sun (или, вернее, уже Oracle), по именованию переменных и методов.

Переменные
И так. Вот перечень основных правил именования переменных:
  • Имена переменных должны начинаться с буквы, знака $ или знака подчеркивания _. Имена не могут начинаться с цифр!
  • После первого символа в имени могут идти любые комбинации букв, цифр, знаков подчеркивания и $.
  • Нет ограничения на количество символов, которое может содержать имя переменной.
  • В качестве имен нельзя использовать зарезервированные в Java слова (перечень приведен ниже).
  • Имена переменных в Java регистрозависимые - переменные с именами foo и FOO это две различные переменные.
Вот примеры допустимых имен:

int a;
int b1;
int _c;
int $d;
int i_am_damn_long_variable_identifier;

А вот примеры недопустимых:

int :e;
int /d;
int f#;
int .g;
int 14h;

Перечень зарезервированных слов в Java:
abstractbooleanbreakbytecasecatch
charclassconstcontinuedefaultdo
doubleelseextendsfinalfinallyfloat
forgotoifimplementsimportinstanceof
intinterfacelongnativenewpackage
privateprotectedpublicreturnshortstatic
strictfpsuperswitchsynchronizedthisthrow
throwstransienttryvoidvolatilewhile
assertenum

Рекомендации по оформлению кода
  • Классы и интерфейсы. Первая буква в имени должна быть заглавной и если в имени содержится несколько слов, то каждую первую букву в последующих словах следует делать заглавной (проще говоря, используйте camelCase). Имена классов следует делать существительными. Например:

    Cat
    FootballTeam

    Имена интерфейсам следует давать в форме прилагательных:

    Runnable
    Serializable
  • Методы. Первую букву следует делать строчной и далее следовать рекомендациям camelCase. Имена следует давать в виде сочетания глаголов и существительных. Например:

    getNumber
    doCalculation
    setCustomerName
  • Переменные. Как и для методов, придерживайтесь camelCase и присваивайте говорящие имена, дабы было понятно для чего эта переменная без всяких комментариев: 

    labelText
    myAwesomeString
  • Константы. Константы в Java создаются с помощью зарезервированных слов static и final. Имена констант следует задавать только заглавными буквами, а слова в имени разделять знаком подчеркивания:

    MY_CONST

Комментариев нет:

Отправить комментарий