Úvod do Naming Convention v Jave
V tomto článku prejdeme niektoré pomenovacie konvencie, ktoré by sa mali dodržiavať najmä v jazyku Java na účely udržiavania kódu a čitateľnosti, ktoré programátorovi pomáhajú porozumieť a upraviť kód napísaný iným programátorom. Môžeme to považovať za usmernenie, ktoré je možné sledovať pri prideľovaní mien jednotlivým triedam, premenným alebo metódam alebo rozhraniam atď. A pri písaní kódov to môže byť dobrý postup. Konvencie pomenovávania, o ktorých budeme diskutovať v tomto článku, navrhujú a praktikujú mnohí programátori Java a podporujú ich aj Netscape a Sun Microsystems.
Syntax v konvenciách názvov Java
V programovacom jazyku Java sa štýl písania veľblúdom používa na písanie názvov metód / funkcií, premenných a štýlu názvu prípadu pre triedy a rozhrania. Poďme sa zoznámiť s pravidlami, ktoré by sme mali dodržiavať pri pomenovávaní prvku / entity v programovacom jazyku Java:
- Pri prideľovaní mien triedam by sme mali mať na pamäti, že názvy tried by mali byť podstatné meno a mali by začínať veľkým písmenom.
Syntax: public class Employee ( //code snippet )
- V prípade rozhraní by malo byť prídavné meno (ktoré opisuje podstatné meno (trieda, ktorá ho implementuje)) a začína sa veľkým písmenom. V niektorých prípadoch môže byť názov rozhrania tiež podstatné meno, ak predstavuje skupinu tried, napr .: Mapa, Zoznam atď.
Syntax: interface Printable ( //code snippet )
- Názov metódy by mal začínať slovesom (definujúcim akciu, ktorú má táto metóda implementovať) a začať malým písmenom.
Syntax: void printDetails() ( //code snippet )
- Zatiaľ čo pre premenné by mali byť zmysluplné, čo znamená, aký druh informácií sa ukladá, či už je to meno alebo adresa, telefónne číslo atď. Pri písaní mien premenných sa musíme uistiť, že to tak nie je začínajú špeciálnymi znakmi, ako je dolár ($) alebo znak podčiarknutia (_), a jeho názov by nemal mať žiadne medzery a začínať malým písmenom.
Syntax: int eid, sal;string firstName, lastName;
- Názvy konštantných premenných by sa mali písať veľkými písmenami (všetky UPPERCASE) a oddelené znakom podčiarknutia (_), ktorého názov pozostáva z viac ako jedného slova.
Syntax: static final int MIN_SAL = 20000;
- Vieme, že Java používa pri prideľovaní názvov balíkov všetky malé písmená a pri pomenovávaní našich balíkov by sme sa mali riadiť rovnakou konvenciou pomenovávania.
Syntax: package src.employeedetails;
- Čísla v kóde java by sa mali používať veľkými písmenami, tj všetky veľké písmená.
Syntax: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )
- Anotácie v jave môžu byť podstatné meno, sloveso alebo prídavné meno a pri pomenovávaní anotácií by mali zodpovedať štýlu veľkosti písmen.
Syntax: public @interface Documented ()
Príklady v konvenciách pomenovávania Java
Teraz nám napíšeme úplný kód pomocou vyššie uvedených úryvkov kódu, čo ho robí zmysluplnejším a pomáha nám pochopiť, prečo sú pri písaní kódu aplikácie v ľubovoľnom programovacom jazyku dôležité nasledujúce konvencie pomenovávania:
Príklad č. 1
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();
)
)
Výkon:
Príklad č. 2
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();
)
)
Výstup 1:
Výstup 2:
Výhody Java Naming Convention
Nižšie sú uvedené niektoré výhody v java menovaní konvencie:
- Zníženie písomného zmätku alebo chybného kódu.
- Zlepšenie čitateľnosti kódu.
- Menej času stráveného zisťovaním, čo kód robí.
- Zlepšenie udržiavateľnosti kódu.
- Vytvorte konzistentný kód v celej aplikácii.
záver
Pri ďalšom písaní kódu Java sa uistite, že triedy, rozhrania, balíčky, metódy a polia, ktoré definujete a implementujete, majú názvy, ktoré zodpovedajú konvenciám názvov Java. Pamätajte si, že nasledujúce konvencie pomenovávania v akomkoľvek programovacom jazyku sú prvým krokom k napísaniu čistého a konzistentného kódu a pravdepodobne ide o prvý najlepší postup, ktorý by mal dodržiavať každý programátor.
Odporúčané články
Toto je sprievodca Java Naming Convention. Tu diskutujeme triedy, rozhrania, balíčky, metódy a polia, ktoré definujú a implementujú konvencie pomenovávania Java. Viac informácií nájdete aj v ďalších súvisiacich článkoch -
- Objekt v PHP
- Štvorce v Jave
- Rekurzia v Jave
- Factorial v Jave
- Premenné v JavaScripte
- Polia v programovaní Java
- Zoznam balíkov R
- Pracovné a najlepšie 3 metódy výčtu v C #
- Kompletný sprievodca faktormi v C #