Въведение в Конвенцията за именуване на 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. Можете също да прегледате и другите ни свързани статии, за да научите повече -
- Обект в PHP
- Квадрати в Java
- Рекурсия в Java
- Factorial в Java
- Променливи в JavaScript
- Масиви в Java програмиране
- Списък на R пакети
- Работа и топ 3 Enum методи в C #
- Пълно ръководство за Factorial в C #