Правила именования констант java

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

Соглашения об именовании Java – это рекомендации и рекомендации по написанию кода на Java. Они делают наш код последовательным и легким для чтения другими разработчиками Java.

При написании кода на 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), за исключением временных одноразовых переменных.
• Имя переменной должно указывать на использование переменной.

5. Соглашения об именовании Констант

• Имя константы должно быть в верхнем регистре.
• В случае, если слов несколько, разделите их подчеркиванием (“_”).

Вывод

Это соглашения об именах, которые облегчат чтение вашего Java-кода. Однако нет необходимости использовать их при написании кода для производства, который будут читать другие люди, лучше всего использовать соглашения об именах Java.

Источник

Правила именования переменных

При именовании классов, методов, переменных и других идентификаторов рекомендуется придерживаться следующих правил:

1. Классы и интерфейсы

• Первая буква в имени должна быть заглавной.
• Если в имени содержится несколько слов, то каждую первую букву в последующих словах следует делать заглавной (СamelCase формат).
• Имена классов следует делать существительными. Например: Cat , Exam , PrintReader .
• Имена интерфейсам следует давать в форме прилагательных: Comparable , Iterable , Navigable .

2. Методы

• Первую букву следует делать строчной и далее следовать рекомендациям СamelCase.
• Имена следует давать в виде сочетания глаголов и существительных: getName , doJob , setLastName .

3. Переменные

• Первую букву следует делать строчной и далее следовать рекомендациям СamelCase.
• Присваивайте короткие говорящие имена, чтобы было понятно для чего используется эта перем енная: firstName , buttonHeight .

4. Константы

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

5. Пакеты

• В имени пакета используются только маленькие буквы.
• Для коммерческих проектов пакет должен начинаться с com, потом следует имя организации и название проекта. Потом пакеты обычно именуются по какому-то функциональному признаку.

Презентацию с видео можно скачать на Patreon .

• Пробелы
• Идентификаторы
• Комментарии
• Разделители
• Ключевые слова
• Примитивные типы данных
• Тип данных char
• Типы byte, short, int, long
• Числа с плавающей точкой
• Тип данных boolean
• Литералы
• Методы
• Переменные
• Прямой код и дополнительный код
• Преобразование и приведение примитивных типов
• Ввод с клавиатуры
• Задания

Источник

Java constant variable, naming convention [duplicate]

Is there any naming convention for java constant variable?
Normally we use variables with names containing uppercase letters and underscores( _ ).
For example:

public final class DeclareConstant

5 Answers 5

Yes. That is it. It is often used for enum as well.

The only common exception is for logging where you might see

private static final Logger log = Logger.getLogger(getClass().getName()); 

I often write this as UPPER_CASE, but I also write TitleCase for classes and camelCase for variables and methods.

Why in case of Logger we use private static final Logger log = Logger.getLogger(getClass().getName()); ?

Im not sure that’s true @peter-lawrey. Things File.separator in the API are lower case. I thought the convention was that if the rhs has to do something eg get a logger then it is lower case. If it is truly a constant then it is upper case

That is right. According to Sun:

Constants

The names of variables declared class constants and of ANSI constants should be all uppercase with words separated by underscores («_»). (ANSI constants should be avoided, for ease of debugging.)

static final int MIN_WIDTH = 4;

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

There doesn’t seem to exist any Java-related definition for ANSI constants. (sources: SO, coderanch.com)

@chepner — Nice comment! As of now, the link is dead, I was able to read the relevant part thanks to you 😉

How about when It comes to groups. Something like : ACTIVE_STATUS_ACTIVE, ACTIVE_STATUS_INACTIVE. I have seen some people use two Underscores to divide group name. Like this: ACTIVE_STATUS__ACTIVE, ACTIVE_STATUS__INACTIVE. Is this a standard to use?

Many of these naming conventions were created well before IDEs were in widespread use. These days, static constants are going to be colored differently than local variables, so the need to use a specific naming convention to identify them is greatly reduced. I would suggest that readability is a more important concern these days, and recommend using camel case instead.

To answer your question though, the other answers are right that this is the official convention. 😉

Readability is enhanced by upper-case constants I would say. Even though modern IDE’s help too of course. Some notations say you should have an «m» before member-variables, e.g. mMember as well, however, in that case where the name is actually altered I would say using IDE-coloring is enough these days.

Источник