Uvod v konvencijo o poimenovanju na Javi

V tem članku bomo preučili nekaj konvencij o poimenovanjih, ki se jih je treba še posebej držati v Javi za namene vzdrževanja in berljivosti kode, ki programerju pomagajo razumeti in spremeniti kodo, ki jo je napisal drug programer. Lahko ga obravnavamo kot vodilo, ki mu lahko sledimo pri dodeljevanju imen svojim razredom, spremenljivkam ali metodam ali vmesnikom itd., In to je dobra praksa pri pisanju kod. Konvencije o poimenovanju, ki jih bomo obravnavali v tem članku, predlagajo in izvajajo mnogi programerji Java, podpirajo pa jih tudi Netscape in Sun Microsystems.

Sintaksa v konvencijah o poimenovanju Java

V programskem jeziku Java se slog pisanja v obliki kamele uporablja za pisanje imen metod / funkcij, spremenljivk in naslova z velikostjo za razrede in vmesnike. Preučimo in razumemo pravila, ki jih je treba upoštevati, ko poimenujemo element / entiteto v programskem jeziku Java:

  • Med dodeljevanjem imen razredom moramo imeti v mislih, da bi morala biti imena samostalnikov in začeti z veliko začetnico.

Sintaksa: public class Employee ( //code snippet )

  • V primeru vmesnikov mora biti ab pridevnik (ki opisuje samostalnik (razred, ki ga izvaja)) in začeti z veliko začetnico. V nekaterih primerih je ime vmesnika lahko tudi samostalnik, kadar predstavljajo družino razredov, na primer: Zemljevid, Seznam itd.

Sintaksa: interface Printable ( //code snippet )

  • Ime metode se mora začeti z glagolom (ki določa dejanje, ki ga bo metoda izvedla) in začeti z malo začetnico.

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

  • Medtem ko bi za spremenljivke morale biti smiselne, kar pomeni, kakšne informacije shranjujejo, ali gre za ime, naslov ali telefonsko številko itd. Ko pišemo imena spremenljivk, moramo paziti, da ne začnite s posebnimi črkami, kot sta znak za dolar ($) ali podčrtaj (_), njegovo ime pa ne sme vsebovati praznih presledkov in začeti z malo začetnico.

Sintaksa: int eid, sal;string firstName, lastName;

  • Imena stalnih spremenljivk morajo biti napisana z veliko začetnico (vsa PODELJAVA) in ločena z podčrtajem (_), njeno ime je sestavljeno iz več besed.

Sintaksa: static final int MIN_SAL = 20000;

  • Vemo, da Java za dodeljevanje imen paketov uporablja vse male črke in bi morali upoštevati isto konvencijo o poimenovanju, medtem ko poimenujemo tudi naše pakete.

Sintaksa: package src.employeedetails;

  • Številke v kodi java morajo biti napisane z veliko začetnico, torej vse velike črke.

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

  • Opombe v javi so lahko samostalnik, glagol ali pridevnik in za poimenovanje pripisov morajo slediti naslovu.

Sintaksa: public @interface Documented ()

Primeri konvencij o poimenovanju Java

Zdaj pa naj napišemo celotno kodo z zgornjimi odseki kode, kar naredi bolj smiselno in nam pomaga razumeti, zakaj so naslednje pisanje konvencij o poimenovanju pomembne pri pisanju kode aplikacije v katerem koli programskem jeziku:

Primer # 1

Koda:

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

Izhod:

Primer # 2

Koda:

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

Izhod 1:

Izhod 2:

Prednosti konvencij o poimenovanju Java

Spodaj je nekaj prednosti konvencije o poimenovanju java:

  • Zmanjšanje zmede pri pisanju ali napačne kode.
  • Izboljšanje berljivosti kode.
  • Manj časa, porabljenega za ugotovitev, kaj počne koda.
  • Izboljšanje vzdrževanja kode.
  • V celotni aplikaciji ustvarite dosledno kodo.

Zaključek

Naslednjič med pisanjem kode Java preverite, ali imajo razredi, vmesniki, paketi, metode in polja, ki jih določite in implementirate, imena, ki sledijo konvencijam o poimenovanju Java. Ne pozabite, da so te konvencije o poimenovanju v katerem koli programskem jeziku prvi korak k pisanju čiste in dosledne kode in verjetno prva najboljša praksa, ki bi jo morali upoštevati vsi programerji.

Priporočeni članki

To je vodnik za konvencije o poimenovanju Java. Tukaj razpravljamo o razredih, vmesnikih, paketih, metodah in poljih, ki definirajo in izvajajo konvencije o poimenovanju Java. Obiščite lahko tudi druge naše sorodne članke, če želite izvedeti več -

  1. Objekt v PHP
  2. Kvadrati na Javi
  3. Rekurzija na Javi
  4. Factorial v Javi
  5. Spremenljivke v JavaScript
  6. Nizi v programiranju Java
  7. Seznam R paketov
  8. Delo in top 3 metode Enum v C #
  9. Celoten vodnik po Factorialu v C #

Kategorija:

Razvoj programske opreme