Автор оригинала: Pankaj Kumar.
При написании кода на Java рекомендуется соблюдать определенные соглашения об именовании. Соглашения об именовании Java обеспечивают некоторую форму единообразия в вашем коде. Это облегчает чтение вашего кода другими разработчиками.
Хотя это не жесткие правила, лучше всего следовать этим правилам при написании кода.
1. Соглашения об Именовании Пакетов Java
- Имя пакета должно быть в маленьком футляре.
- В случае, если слов несколько, разделите их точкой.
- Префикс должен быть одним из доменных имен верхнего уровня, таких как com, edu, gov, mil, net, org, или одним из английских двухбуквенных кодов, идентифицирующих страны. (В США, Великобритании)
Пример:
package com.journaldev.util;
2. Соглашения об именовании классов и интерфейсов
- Имена классов и интерфейсов должны быть существительными.
- Они могут быть в смешанном регистре, но первая буква каждого внутреннего слова должна быть прописной. Это означает, что первая буква имени класса и интерфейса также должна быть прописной.
- Избегайте сокращений и аббревиатур.
Пример:
public class Vehicle
{
//code
}
class CarCleaningShop {
}
3. Соглашение об именовании методов Java
- Методы должны быть глаголами, указывающими на функциональность этого конкретного метода.
- Они могут быть в смешанном случае.
- Первая буква должна быть в нижнем регистре, а каждое последующее слово должно содержать первую букву в верхнем регистре.
Пример:
void slowDown()
{
//code
}
void getCustomerAddress() {
}
4. Соглашения об Именовании переменных Java
- Имена переменных не должны начинаться с символа подчеркивания (_) или знака доллара ( $ ).
- Начинайте имена переменных со строчной буквы, при этом каждое последующее слово должно содержать первую букву в верхнем регистре.
- Избегайте использования односимвольных имен переменных (i,j,k), за исключением временных одноразовых переменных.
- Имя переменной должно указывать на использование переменной.
public class Vehicle
{
public void slowDown()
{
int speed;
int timeToStop;
}
}
5. Соглашения об именовании Констант
- Имя константы должно быть в верхнем регистре.
- В случае, если слов несколько, разделите их подчеркиванием (“_”).
Пример:
public class Vehicle {
static final int MAX_SPEED = 120;
}
Вывод
Это соглашения об именах, которые облегчат чтение вашего Java-кода. Однако нет необходимости использовать их при написании кода для производства, который будут читать другие люди, лучше всего использовать соглашения об именах Java.