Введение в соглашение об именах в Java

В этой статье мы рассмотрим некоторые соглашения об именах, которые должны соблюдаться, особенно в Java, для удобства сопровождения и читабельности кода, которые помогают программисту понимать и модифицировать код, написанный другим программистом. Мы можем рассматривать это как руководство, которому можно следовать при назначении имен своим классам, переменным или методам или интерфейсам и т. Д., И сделать это хорошей практикой при написании кодов. Соглашения об именах, которые мы обсудим в этой статье, предлагаются и применяются многими программистами Java, а также поддерживаются Netscape и Sun Microsystems.

Синтаксис в соглашениях об именах Java

В языке программирования Java стиль написания верблюжьих букв используется для написания имен методов / функций, переменных и стиля заглавных букв для классов и интерфейсов. Давайте разберемся и поймем правила, которым нужно следовать, называя элемент / сущность на языке программирования Java:

  • При назначении имен классам, мы должны помнить, что имена классов должны быть существительными и начинаться с заглавной буквы.

Синтаксис: public class Employee ( //code snippet )

  • В случае интерфейсов, оно должно быть ab прилагательным (которое описывает существительное (класс, который его реализует)) и начинаться с заглавной буквы. В некоторых случаях имя интерфейса также может быть существительным, когда они представляют семейство классов, например: Map, List и т. Д.

Синтаксис: interface Printable ( //code snippet )

  • Имя метода должно начинаться с глагола (определяющего действие, которое метод будет реализовывать) и начинаться со строчной буквы.

Синтаксис: void printDetails() ( //code snippet )

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

Синтаксис: int eid, sal;string firstName, lastName;

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

Синтаксис: static final int MIN_SAL = 20000;

  • Мы знаем, что Java использует все строчные буквы для назначения имен пакетов, и мы должны следовать тем же правилам именования, что и имена наших пакетов.

Синтаксис: package src.employeedetails;

  • Перечисления в вашем коде Java должны быть заглавными, т.е. все заглавные буквы.

Синтаксис: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )

  • Аннотации в java могут быть существительными, глаголами или прилагательными и должны следовать стилю заголовка для именования аннотаций.

Синтаксис: public @interface Documented ()

Примеры в соглашениях об именах Java

Теперь давайте напишем полный код, используя приведенные выше фрагменты кода, что делает его более значимым и помогает нам понять, почему следующие соглашения об именах важны при написании кода приложения на любом языке программирования:

Пример № 1

Код:

package src.employeedetails;
interface Printable (
void printDetails(); )
public class Employee implements Printable (
int eid;
double sal;
String firstName, lastName;
// Default Constructor
Employee() (
eid=0; sal=0.0;
firstName = "Anonymous"; lastName = "Anonymous";
)
// Parameterized Constructor
Employee(int eid, double sal, String firstName, String lastName) (
this.eid = eid; this.sal = sal;
this.firstName = firstName; this.lastName = lastName;
)
public void printDetails() (
System.out.println("Employee ID:" + eid + "\n" +
"Employee First Name:" + firstName + "\n" +
"Employee Last Name:" + lastName + "\n" +
"Employee Salary:" + sal + "\n" );
)
public static void main(String args()) (
Employee emp = new Employee(1, 22368.50, "Alan", "Hope");
emp.printDetails();
)
)

Выход:

Пример № 2

Код:

package src.customerdetails;
interface Printable ( void printDetails(); )
public class Customer implements Printable (
int custid;
long mobNo;
String fullName, emailAddr;
// Default Constructor
Customer() (
custid=0; mobNo=0;
fullName = "Anonymous"; emailAddr = " ";
)
// Parameterized Constructor
Customer(int custid, long mobNo, String fullName, String emailAddr) (
this.custid = custid; this.mobNo = mobNo;
this.fullName = fullName; this.emailAddr = emailAddr;
)
public void printDetails() (
System.out.println("Customer ID:" + custid + "\n" +
"Customer Full Name:" + fullName + "\n" +
"Customer Email Address:" + emailAddr + "\n" +
"Customer Mobile Number:" + mobNo + "\n" );
)
public static void main(String args()) (
Customer cust = new Customer (1, 987451036, "Alan Hope", " ");
cust.printDetails();
)
)

Выход 1:

Выход 2:

Преимущества соглашений об именах Java

Ниже приведены некоторые преимущества в соглашении об именовании Java:

  • Снижение путаницы или ошибочного кода.
  • Улучшение читаемости кода.
  • Меньше времени, потраченного на выяснение того, что делает код.
  • Улучшение сопровождения кода.
  • Создайте согласованный код во всем приложении.

Вывод

В следующий раз при написании кода Java убедитесь, что у классов, интерфейсов, пакетов, методов и полей, которые вы определяете и реализуете, есть имена, соответствующие соглашениям об именах Java. Помните, что следующие соглашения об именах на любом языке программирования - это первый шаг к написанию чистого и согласованного кода и, вероятно, первая лучшая практика, которой должен следовать каждый программист.

Рекомендуемые статьи

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

  1. Объект в PHP
  2. Квадраты в Яве
  3. Рекурсия на Яве
  4. Факториал на Яве
  5. Переменные в JavaScript
  6. Массивы в программировании на Java
  7. Список пакетов R
  8. Рабочие и лучшие 3 метода перечисления в C #
  9. Полное руководство по факториалу в C #

Категория:

Разработка программного обеспечения