Introducere în Convenția privind denumirea în Java

În acest articol vom parcurge câteva convenții de denumire care ar trebui urmate în special în Java, în scopul menținerii și lizibilității codului, care ajută un programator să înțeleagă și să modifice codul scris de un alt programator. Îl putem considera ca un ghid pe care îl putem urma în timp ce atribuim nume pentru clase, variabile sau metode sau interfețe, etc. și îl putem face o bună practică în timp ce scriem coduri. Convențiile de denumire despre care vom discuta în acest articol sunt sugerate și practicate de mulți programatori Java și de asemenea susținute de Netscape și Sun Microsystems.

Sintaxa în Convențiile de denumire Java

În limbajul de programare Java, stilul de scriere al cazurilor cu cămile este utilizat pentru scrierea numelor de metode / funcții, variabile și stilul cazului de titlu pentru clase și interfețe. Să parcurgem și să înțelegem regulile pe care trebuie să le respectăm în timp ce numim un element / entitate în limbajul de programare Java:

  • În timp ce alocăm nume unor clase, trebuie să reținem că numele clasei ar trebui să fie un substantiv și să începem cu majuscule.

Sintaxa: public class Employee ( //code snippet )

  • În cazul interfețelor, ar trebui să fie un adjectiv ab (care descrie substantivul (o clasă care îl pune în aplicare)) și să înceapă cu majusculă. În unele cazuri, un nume de interfață poate fi și un substantiv, atunci când reprezintă o familie de clase, ex: Hartă, Listă etc.

Sintaxa: interface Printable ( //code snippet )

  • Un nume de metodă ar trebui să înceapă cu un verb (definirea unei acțiuni pe care metoda urmează să o implementeze) și să înceapă cu o litere mică.

Sintaxa: void printDetails() ( //code snippet )

  • În timp ce pentru variabile, acestea ar trebui să aibă semnificații, ceea ce înseamnă ce tip de informații stochează dacă este vorba de un nume, o adresă sau un număr de telefon, etc. Când scrieți numele variabilelor, trebuie să ne asigurăm că nu începe cu caractere speciale, cum ar fi un dolar ($) sau un semn de subliniere (_) și numele său nu ar trebui să aibă nicio spațiu alb și să înceapă cu o litere mică.

Sintaxă: int eid, sal;string firstName, lastName;

  • Numele variabilelor constante trebuie majusculate complet (toate UPPERCASE) și separate cu un semn de subliniere (_), numele său este format din mai mult de un cuvânt.

Sintaxă: static final int MIN_SAL = 20000;

  • Știm că Java folosește toate literele minuscule pentru atribuirea numelor de pachete și ar trebui să urmăm aceeași convenție de denumire în timp ce numim și pachetele noastre.

Sintaxa: package src.employeedetails;

  • Enumerațiile din codul dvs. java ar trebui majusculate, adică toate literele majuscule.

Sintaxa: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )

  • Adnotările în java pot fi un substantiv, un verb sau un adjectiv și ar trebui să urmeze stilul de caz-titlu pentru denumirea adnotărilor.

Sintaxa: public @interface Documented ()

Exemple în convențiile de denumire Java

Acum, să scriem un cod complet folosind fragmentele de cod de mai sus, care îl fac mai semnificativ și ne ajută să înțelegem de ce urmările convențiilor de denumire sunt importante în timp ce scriem codul aplicației în orice limbaj de programare:

Exemplul # 1

Cod:

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();
)
)

ieşire:

Exemplul # 2

Cod:

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();
)
)

Rezultat 1:

Rezultat 2:

Avantajele convențiilor de denumire Java

Mai jos sunt câteva avantaje în convenția de denumire java:

  • Reducerea confuziei în scris sau codul eronat.
  • Îmbunătățirea lizibilității codurilor.
  • Mai puțin timp petrecut pentru a-ți da seama ce face codul.
  • Îmbunătățirea menținerii codului.
  • Produceți un cod consistent în toată aplicația.

Concluzie

Data viitoare în timp ce scrii un cod Java, asigurați-vă că clasele, interfețele, pachetele, metodele și câmpurile pe care le definiți și le implementați au nume care respectă convențiile de denumire Java. Nu uitați de cele care urmează convenții de denumire în orice limbaj de programare este primul pas pentru a scrie un cod curat și consistent și este probabil prima bună practică pe care trebuie să o urmeze toată lumea programator.

Articole recomandate

Acesta este un ghid al Convențiilor de denumire Java. Aici discutăm clasele, interfețele, pachetele, metodele și câmpurile care definesc și implementează convențiile de denumire Java. Puteți parcurge și alte articole conexe pentru a afla mai multe -

  1. Obiect în PHP
  2. Pătrate în Java
  3. Recursiune în Java
  4. Factorial în Java
  5. Variabile în JavaScript
  6. Schiri în programare Java
  7. Lista pachetelor R
  8. Funcționare și Top 3 Metode Enum în C #
  9. Ghid complet pentru factorial în C #

Categorie:

Dezvoltare de software