Целью предоставления стандартов кодирования является улучшение читабельности и аккуратности кода, чтобы любой участник проекта или группы (или кто угодно) мог легко понять код и работать над ним.
Написание кода без стандартов кодирования может показаться легким, когда вы делаете код, и после этого даже вам самому будет труднее понять и устранить ошибки при отладке. Поскольку многие разработчики работают над одним и тем же проектом, необходимо следовать стандартам кодирования.
В большинстве случаев мы пишем код не только для понимания машиной, но и для понимания другими разработчиками, поскольку им может потребоваться прочитать код и изменить его, исправить ошибки или добавить дополнительные функции. .
Преимущества использования стандартов кодирования:
- Хороший, аккуратный и всеобъемлющий вид.
- Более читаемый.
- Повышенная эффективность
- Простота обслуживания
- Легче работать над ошибками.
Стандарты кодирования Java:
- Соглашения об именах
Имена пакетов следует вводить строчными буквами, например com.testdata.
Класс, перечисление, интерфейс, аннотация должны быть набраны в UpperCamelCase. пример класса Animal, класса Dog.
Константы следует вводить в верхнем регистре, разделяя символом подчеркивания. пример ИНДЕКС,ТАБЛИЦА_ИНДЕКС.
Имя метода должно состоять из глаголов и быть напечатано в нижнем верблюжьем регистре. пример noOfPeople,marksOfAllSubjects.
Переменные следует набирать в нижнем верблюжьем регистре. пример
Сокращения не должны использоваться, но если они используются, они должны быть задокументированы.
2. Декларации
Рекомендуется одно объявление на строку, так как это способствует комментированию и повышает ясность кода.
Переменные статические/класса должны располагаться в следующей последовательности: сначала переменные открытого класса, защищенные, уровень package/default, то есть без модификатора доступа, а затем private.
конструкторы класса должны быть объявлены в начале внутри класса, если это применимо.
Избегайте многократного объявления одной и той же переменной. Следует избегать локальных объявлений, которые скрывают объявления на более высоких уровнях. Например, следует избегать того же имени переменной во внутреннем блоке, что и у глобальной переменной.
Объявления для локальных переменных должны находиться только в начале блоков.
Числовые константы не следует кодировать напрямую.
3. Организация исходного файла
Каждый класс должен быть помещен в отдельный файл. Каждый исходный файл Java должен содержать один класс или интерфейс.
Если выражение не помещается на одном экране, разбейте его после запятой или новой строки. Линии за пределами экрана нежелательны.
Максимальное количество параметров в любом классе предпочтительно равно 12.
Исходный файл должен содержать менее 2000 строк кода.
Пустые строки следует использовать только тогда, когда это необходимо для улучшения читаемости кода путем группировки разделов кода.
Желательно, чтобы все исходные файлы имели комментарий к документации, который может содержать такую информацию, как название, версия, дата, автор и т. д. За ним следует объявление пакета, за которым следует комментарий класса.
По возможности старайтесь уменьшить размер функции (5–15 строк).
Открывающая и закрывающая фигурные скобки должны быть выровнены и находиться на разных строках. Начальная фигурная скобка ({) должна быть в конце той же строки, что и оператор объявления или метод, а конечная фигурная скобка (}) должна быть на отдельной строке и выровнена. с условным/классом.
Все бинарные операторы, кроме «.» должны быть разделены пробелом.
4. Коды комментариев
Комментарии к документации. Эти комментарии описывают спецификацию кода с точки зрения свободной от реализации. Это написано в HTML и должно предшествовать объявлению класса, поля, конструктора или метода. Он должен быть написан в определенном формате (см. эту ссылку).
Подробнее о комментариях по этой ссылке.
5. Для всех
Не переопределяйте какой-либо метод, если его реализация не изменилась.
Всегда имейте регистр по умолчанию в коммутаторе, даже если нет кода.
Убедитесь, что код имеет правильный отступ.
Необходимо позаботиться о области действия каждой переменной и метода.
Обязательно применяйте инкапсуляцию (концепцию ООП) всякий раз, когда это необходимо для обеспечения безопасности кода.
