Uvod u konvenciju o imenovanju na Javi

U ovom ćemo članku proći neke konvencije o imenovanju kojih se posebno treba pridržavati u Javi u svrhu održavanja i čitljivosti koda, a koji pomažu programeru da razumije i izmijeni kod koji je napisao drugi programer. Možemo ga smatrati smjernicom koju osoba može slijediti prilikom dodjeljivanja imena nečijim klasama, varijablama ili metodama ili sučeljima itd. I učiniti je dobrom praksom dok pišete kodove. Konvencije imenovanja o kojima ćemo govoriti u ovom članku su predloženi i prakticirani od strane mnogih Java programera, a podržavaju ih i Netscape i Sun Microsystems.

Sintaksa u Java Konvencijama o imenovanju

U programskom jeziku Java stil pisanja u obliku kamile koristi se za pisanje imena metoda / funkcija, varijabli i stila naziva naslovnice za klase i sučelja. Provjerimo i razumemo pravila koja se treba pridržavati prilikom imenovanja elementa / entiteta u programskom jeziku Java:

  • Tijekom dodjeljivanja imena razredima, trebamo imati na umu da bi imena klasa trebala biti imenica i počinjati velikim slovom.

Sintaksa: public class Employee ( //code snippet )

  • U slučaju sučelja, to bi trebao biti ab pridjev (koji opisuje imenicu (klasa koja je provodi)) i započeti velikim slovom. U nekim slučajevima ime sučelja može biti i imenica kada predstavljaju obitelj klasa, npr .: Karta, Popis itd.

Sintaksa: ispisno interface Printable ( //code snippet )

  • Naziv metode trebao bi početi glagolom (koji definira radnju koju će metoda provoditi) i započeti malim slovom.

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

  • Dok bi za varijable trebale biti smislene, što znači kakve informacije pohranjuju bilo da se radi o imenu, adresi ili telefonskom broju itd. Pri pisanju imena varijabli, moramo se pobrinuti da ih ne započnite s posebnim znakovima kao što su znak (dolar) ili znak podvlake (_), a njegovo ime ne bi trebalo imati praznih prostora i započnite malim slovom.

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

  • Nazivi konstantnih varijabli trebaju biti napisani velikim slovom (sav UPPERCASE) i razdvojeni podcrtanim znakom (_), a naziv se sastoji od više riječi.

Sintaksa: static final int MIN_SAL = 20000;

  • Znamo da Java koristi sva mala slova za dodjelu imena paketa i trebali bismo slijediti istu konvenciju o imenovanju tijekom imenovanja naših paketa.

Sintaksa: package src.employeedetails;

  • Napisi u vašem java kôdu trebaju biti napisani velikim slovom, odnosno sva velika slova.

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

  • Bilješke u javi mogu biti imenica, glagol ili pridjev i trebale bi slijediti stil naslova za imenovanje napomena.

Sintaksa: public @interface Documented ()

Primjeri u Java konvencijama o imenovanju

Sada ćemo napisati cijeli kôd pomoću gore navedenih isječaka koda što ga čini smislenijim i pomaže nam da shvatimo zašto su sljedeće konvencije o imenovanju važne za vrijeme pisanja programskog koda na bilo kojem programskom jeziku:

Primjer 1

Kodirati:

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

Izlaz:

Primjer 2

Kodirati:

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

Izlaz 1:

Izlaz 2:

Prednosti Java konvencija o imenovanju

Ispod su neke od prednosti u konvenciji imenovanja java:

  • Smanjenje zabune u pisanju ili pogrešnog koda.
  • Poboljšanje čitljivosti koda.
  • Manje vremena utrošenog da shvatim što radi kod.
  • Poboljšanje održavanja koda.
  • Stvorite dosljedan kôd u cijeloj aplikaciji.

Zaključak

Sljedeći put dok pišete Java kôd, pobrinite se da klase, sučelja, paketi, metode i polja koja definirate i implementirate imaju imena koja slijede Java odredbe o imenovanju. Sjetite se da su sljedeći postupci imenovanja na bilo kojem programskom jeziku prvi korak u pisanju čistog i konzistentnog koda i vjerojatno je prva najbolja praksa koju trebaju slijediti svi programeri.

Preporučeni članci

Ovo je vodič za Java imenovanje konvencija. Ovdje smo raspravljali o klasama, sučeljima, paketima, metodama i poljima koja definiraju i provode Java konvencije o imenovanju. Možete i pregledati naše druge povezane članke da biste saznali više -

  1. Objekt u PHP-u
  2. Kvadrati u Javi
  3. Rekurzija u Javi
  4. Čimbenik u Javi
  5. Varijable u JavaScript-u
  6. Nizi u Java programiranju
  7. Popis R paketa
  8. Rad i top 3 enum metode u C #
  9. Kompletni vodič za Factorial u C #

Kategorija: