Вступ до Конвенції про іменування на Яві

У цій статті ми переглянемо деякі умови іменування, яких слід дотримуватися особливо на Java для цілей ремонту коду та читабельності, які допомагають програмісту зрозуміти та змінити код, написаний іншим програмістом. Ми можемо розглядати це як настанову, якої можна дотримуватися, призначаючи імена класам, змінній чи методам чи інтерфейсам тощо, і робити це хорошою практикою під час написання кодів. Конвенції про іменування, про які ми поговоримо в цій статті, пропонуються та практикуються багатьма Java-програмістами, а також підтримуються Netscape та Sun Microsystems.

Синтаксис у конвенціях про іменування Java

У мові програмування Java стиль написання верблюда в регістрі використовується для написання назв методів / функцій, змінних і стилю заголовка для класів та інтерфейсів. Давайте розберемося та зрозуміємо правила, яких слід дотримуватися, називаючи елемент / сутність в мові програмування Java:

  • Призначаючи імена класам, ми повинні мати на увазі, що імена класів повинні бути іменником і починати з великої літери.

Синтаксис: співробітник public class Employee ( //code snippet )

  • У випадку інтерфейсів це має бути прикметник ab (який описує іменник (клас, який реалізує його)) і починати з великої літери. У деяких випадках ім'я інтерфейсу може бути іменником, коли вони представляють сімейство класів, наприклад: Карта, Список тощо.

Синтаксис: 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. Рекурсія на Java
  4. Факторський на Яві
  5. Змінні в JavaScript
  6. Масиви в програмуванні Java
  7. Список пакетів R
  8. Робота та найкращі 3 методи Enum у C #
  9. Повне керівництво по Factorial в C #

Категорія:

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