Bevezetés a Java elnevezési egyezménybe
Ebben a cikkben néhány elnevezési konvención megyünk keresztül, amelyeket különösen a Java-ban kell követni a kód karbantarthatóságának és olvashatóságának céljából, amelyek segítenek a programozónak megérteni és módosítani egy másik programozó által írt kódot. Útmutatónak tekinthetjük, amelyet követhetünk, amikor nevet rendelünk az osztályokhoz, változóhoz vagy módszerekhez, vagy interfészekhez stb., És jó gyakorlatként tehetjük azt kódok írása közben. Az elnevezési konvenciókat, amelyeket ebben a cikkben tárgyalunk, sok Java programozó javasolja és gyakorolja, és a Netscape és a Sun Microsystems is támogatja.
Szintaxis a Java elnevezési konvenciókban
A Java programozási nyelvben a teve-esetek írásmódját használják a módszerek / függvények, a változók és az eset- és stílusnév írására az osztályok és interfészek számára. Vizsgáljuk meg azokat a szabályokat, amelyeket be kell tartani az elem / entitás elnevezésekor a Java programozási nyelvben:
- A nevek osztályokhoz rendelésekor szem előtt kell tartanunk, hogy az osztályneveknek főnévnek kell lenniük, és nagybetűvel kell kezdődni.
Szintaxis: public class Employee ( //code snippet )
- Interfészek esetében abjev melléknévnek kell lennie (amely leírja a főnevet (az azt végrehajtó osztály)), és nagybetűvel kell kezdődnie. Bizonyos esetekben az interfész neve főnév is lehet, ha osztályok családját képviselik, pl .: Térkép, Lista stb.
Szintaxis: interface Printable ( //code snippet )
- A metódus nevének egy igével kell kezdődnie (amely meghatározza a metódus végrehajtására szolgáló műveletet), és kisbetűvel kell kezdődnie.
Szintaxis: void printDetails() ( //code snippet )
- Míg a változók esetében azoknak értelmeseknek kell lenniük, amelyek jelzik, hogy milyen információt tárol, legyen szó névről, címről, telefonszámról stb. A változók neveinek írásakor ügyelnünk kell arra, hogy olyan speciális karakterekkel kezdõdik, mint például egy dollár ($) vagy aláhúzott karakter (_), és a nevében nem lehet semmilyen szóköz, és kisbetûvel kezdõdik.
Szintaxis: int eid, sal;string firstName, lastName;
- Az állandó változók nevének teljes betűje nagybetűvel történik (összes FELKÖZ), és aláhúzott jellel (_) elválasztva, a név egynél több szót tartalmaz.
Szintaxis: static final int MIN_SAL = 20000;
- Tudjuk, hogy a Java minden kisbetűt használ a csomagnevek hozzárendelésére, és ugyanazt az elnevezési konvenciót kell követnünk, amikor a csomagjainkat is elnevezzük.
Szintaxis: package src.employeedetails;
- A java-kódban szereplő számokat nagybetűkkel kell használni, azaz minden nagybetűt.
Szintaxis: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- A java-ban szereplő jelölések főnév, ige vagy melléknév lehetnek, és a megnevezések elnevezéséhez a cím-eset stílusúaknak kell lenniük.
Szintaxis: public @interface Documented ()
Példák a Java elnevezési konvenciókban
Írjunk egy teljes kódot a fenti kódrészletek segítségével, ami értelmesebbé teszi és megérti, miért fontosak a következő elnevezési konvenciók, miközben az alkalmazáskódot bármilyen programozási nyelven írjuk:
1. példa
Kód:
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();
)
)
Kimenet:
2. példa
Kód:
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. kimenet:
2. kimenet:
A Java elnevezési konvenciók előnyei
Az alábbiakban néhány előnye van a java elnevezési konvenciónak:
- Az írásbeli zavar vagy hibás kód csökkentése.
- A kód olvashatóságának javítása.
- Kevesebb időt töltött ahhoz, hogy kitaláljuk, mi a kód.
- A kód karbantarthatóságának javítása.
- Készítsen egységes kódot az alkalmazás során.
Következtetés
A Java-kód írásakor legközelebb győződjön meg arról, hogy az Ön által definiált és megvalósított osztályok, interfészek, csomagok, módszerek és mezők nevei megfelelnek a Java elnevezési konvencióknak. Ne feledje, hogy az elnevezési konvenciók bármelyik programozási nyelven történő követése az első lépés a tiszta és következetes kód megírásához, és valószínűleg ez az első legjobb gyakorlat, amelyet minden programozónak követnie kell.
Ajánlott cikkek
Ez egy útmutató a Java elnevezési konvenciókhoz. Itt tárgyaljuk azokat az osztályokat, interfészeket, csomagokat, módszereket és mezőket, amelyek meghatározzák és végrehajtják a Java elnevezési konvenciókat. Megnézheti más kapcsolódó cikkeket is, ha többet szeretne megtudni -
- Objektum a PHP-ben
- Négyzetek a Java-ban
- Rekurszió Java-ban
- Faktorial Java
- Változók a JavaScript-ben
- Tömbök a Java programozásban
- Az R csomagok listája
- Munka és a 3 legfontosabb Enum módszer a C # -ben.
- A Factorial teljes útmutatója C #