Introduzione alla convenzione di denominazione in Java
In questo articolo esamineremo alcune convenzioni di denominazione che dovrebbero essere seguite soprattutto in Java per scopi di manutenibilità e leggibilità del codice, che aiutano un programmatore a comprendere e modificare il codice scritto da un altro programmatore. Possiamo considerarlo come una linea guida che si può seguire durante l'assegnazione di nomi alle proprie classi, variabili o metodi o interfacce, ecc. E renderlo una buona pratica durante la scrittura di codici. Le convenzioni di denominazione di cui parleremo in questo articolo sono suggerite e praticate da molti programmatori Java e supportate anche da Netscape e Sun Microsystems.
Sintassi delle convenzioni di denominazione Java
Nel linguaggio di programmazione Java, lo stile di scrittura camel-case viene utilizzato per scrivere nomi di metodi / funzioni, variabili e stile case-title per classi e interfacce. Esaminiamo e comprendiamo le regole da seguire durante la denominazione di un elemento / entità in Java Programming Language:
- Durante l'assegnazione dei nomi alle classi, dovremmo tenere presente che i nomi delle classi dovrebbero essere un sostantivo e iniziare con una lettera maiuscola.
Sintassi: public class Employee ( //code snippet )
- Nel caso delle interfacce, dovrebbe essere un aggettivo (che descrive il sostantivo (una classe che lo implementa)) e iniziare con una lettera maiuscola. In alcuni casi, anche un nome di interfaccia può essere un sostantivo, quando rappresentano una famiglia di classi, ad esempio: Mappa, Elenco, ecc.
Sintassi: interface Printable ( //code snippet )
- Il nome di un metodo dovrebbe iniziare con un verbo (che definisce un'azione che quel metodo sta per implementare) e iniziare con una lettera minuscola.
Sintassi: void printDetails() ( //code snippet )
- Considerando che per le variabili, dovrebbero essere significative, il che significa che tipo di informazioni memorizza se si tratta di un nome, o un indirizzo, o un numero di telefono, ecc. Quando si scrivono nomi di variabili, è necessario assicurarsi che non inizia con caratteri speciali come un dollaro ($) o un segno di sottolineatura (_) e il suo nome non deve contenere spazi bianchi e inizia con una lettera minuscola.
Sintassi: int eid, sal;string firstName, lastName;
- I nomi delle variabili costanti devono essere scritti in maiuscolo (tutto MAIUSCOLO) e separati da un segno di sottolineatura (_), il suo nome è composto da più di una parola.
Sintassi: static final int MIN_SAL = 20000;
- Sappiamo che Java utilizza tutte le lettere minuscole per assegnare i nomi dei pacchetti e dovremmo seguire la stessa convenzione di denominazione anche durante la denominazione dei nostri pacchetti.
Sintassi: package src.employeedetails;
- Le enumerazioni nel codice java devono essere in maiuscolo, cioè tutte le lettere maiuscole.
Sintassi: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- Le annotazioni in java possono essere un sostantivo, un verbo o un aggettivo e devono seguire lo stile del caso per nominare le annotazioni.
Sintassi: public @interface Documented ()
Esempi in Convenzioni di denominazione Java
Ora, scriviamo un codice completo usando i frammenti di codice sopra che lo rende più significativo e ci aiuta a capire perché le seguenti convenzioni di denominazione sono importanti durante la scrittura del codice dell'applicazione in qualsiasi linguaggio di programmazione:
Esempio 1
Codice:
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();
)
)
Produzione:
Esempio n. 2
Codice:
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();
)
)
Uscita 1:
Uscita 2:
Vantaggi delle convenzioni di denominazione Java
Di seguito sono riportati alcuni vantaggi della convenzione di denominazione Java:
- Riduzione della confusione scritta o del codice errato.
- Miglioramento della leggibilità del codice.
- Meno tempo impiegato per capire cosa fa il codice.
- Miglioramento della manutenibilità del codice.
- Produrre un codice coerente in tutta l'applicazione.
Conclusione
La prossima volta, durante la scrittura di un codice Java, assicurarsi che le classi, le interfacce, i pacchetti, i metodi e i campi definiti e implementati abbiano nomi che seguono le convenzioni di denominazione Java. Ricorda che seguire le convenzioni di denominazione in qualsiasi linguaggio di programmazione è il primo passo per scrivere codice pulito e coerente ed è probabilmente la prima best practice che tutti i programmatori dovrebbero seguire.
Articoli consigliati
Questa è una guida alle convenzioni di denominazione Java. Qui discutiamo le classi, le interfacce, i pacchetti, i metodi e i campi che definiscono e implementano le convenzioni di denominazione Java. Puoi anche consultare i nostri altri articoli correlati per saperne di più -
- Oggetto in PHP
- Quadrati in Java
- Ricorsione in Java
- Fattoriale in Java
- Variabili in JavaScript
- Matrici nella programmazione Java
- Elenco dei pacchetti R
- Lavorare e primi 3 metodi Enum in C #
- Guida completa al fattoriale in C #