Стандарты кодирования Java

Почему у нас должны быть стандарты и методы работы с кодом?

• Основная цель рекомендации — улучшить читаемость и понимание, ремонтопригодность и общее качество кода.
• Это улучшает читаемость и ремонтопригодность кода, а также снижает сложность.
• Это помогает повторно использовать код и помогает легко обнаруживать ошибки.

Теперь давайте поговорим о соглашении об именах в Java:

1. Название пакета: -

Это должно быть в нижнем регистре, например java, lang. Если имя содержит несколько слов, оно должно быть разделено точками (.), например java.util, java. яз.

com.graphics.rectangle.ui

2. Имя класса и интерфейса: -

Он должен начинаться с заглавной буквы. Это должно быть существительное, такое как Цвет, Кнопка, Система, Нить и т. д.

Примеры:-

класс Велосипед, интерфейс Спорт, класс Футбол Спорт и т.д.

3. Имя метода: -

Обычно имя метода должно быть либо глаголом, либо комбинацией глагол-существительное, начинающейся с нижней буквы. Если он содержит несколько слов, то каждое внутреннее слово должно начинаться с прописной буквы.

Примеры: print(), sleep() и т. д.

4. Имя переменной: -

i) Переменная экземпляра: - Обычно имя переменной должно быть существительным, начинающимся со строчной буквы. Если он содержит несколько слов, то каждое внутреннее слово должно начинаться с прописной буквы.

Примеры: имя, возраст. мобильный и т. д.

ii) Константы: - Обычно имя константы должно быть существительным. Он должен содержать только заглавные буквы. Если он содержит несколько слов, то слова разделяются символом подчеркивания ( _ ). Обычно мы объявляем константы с модификаторами public static и final.

Примеры: MAX_ITERATIONS, COLOUR_RED и т. д.

iii) логические переменные: -используется в качестве префикса перед именем переменной.

Пример: — isSet, isVisible, isFinished, isFound, isOpen и т. д.

iv) Частная переменная: - используется подчеркивание ( _ ) в конце имени переменной.

Пример:- частная строка name_;

5. Java-бин:-

Java Bean — это простой класс Java с частными свойствами и общедоступными методами получения и установки.

Методы получения:

1. Это должен быть общедоступный метод
2. Имя метода должно начинаться с префикса «get».
3. Это не должно принимать никаких аргументов

Методы установки:

1. Это должен быть общедоступный метод
2. Тип возвращаемого значения должен быть пустым.
3. Имя метода должно начинаться с префикса «set».
4. Это должно принять некоторые аргументы

Некоторые моменты, касающиеся стандартов кодирования: -

1. Переменные итератора должны называться i, j, k и т. д.

Пример:- for (int i = 0; i ‹ n; i++) { }

2. Следует избегать отрицательных логических имен переменных.

Пример:-

логическое значение isError; // НЕ : это не ошибка

Боллеан найден; // НЕ: не найдено

3. Переменные должны быть инициализированы, а не просто объявлены.

int sum = 0; (Good Way)
sum = a + b;int sum; 
sum = 0;
sum = a + b; (Average Way)

4. Массивы должны быть объявлены с квадратными скобками рядом с типом.

Пример:-

5. Импортированные классы всегда должны быть указаны явно.

Явный импорт классов дает отличную документацию для имеющегося класса и упрощает его понимание и поддержку.

Пример:-

Ссылки:-