Sissejuhatus Java nimekonventsiooni

Selles artiklis tutvume mõningate nimetamistavadega, mida tuleks eriti Java puhul koodide hooldatavuse ja loetavuse huvides järgida, mis aitavad programmeerijal mõista ja muuta teise programmeerija kirjutatud koodi. Me võime seda pidada suuniseks, mida saab klassidele, muutujatele või meetoditele või liidestele jne nime määramisel järgida ning muuta seda koodide kirjutamisel heaks tavaks. Nimed, mida selles artiklis käsitleme, on soovitanud ja praktiseerinud paljud Java programmeerijad ning neid toetavad ka Netscape ja Sun Microsystems.

Süntaks Java nimetamise tavades

Java programmeerimiskeeles kasutatakse kaameli juhtumi kirjutamisstiili meetodite / funktsioonide nimede, muutujate ja klasside ning liideste nimetuste kirjutamiseks. Tutvume reeglitega, mida tuleks järgida elemendi / olemi nimetamisel Java programmeerimiskeeles:

  • Klassidele nimede määramisel peaksime meeles pidama, et klasside nimed peaksid olema nimisõna ja algama suure tähega.

Süntaks: public class Employee ( //code snippet )

  • Liideste puhul peaks see olema ab-omadussõna (see kirjeldab nimisõna (klass, mis seda rakendab)) ja algama suure tähega. Mõnel juhul võib liidese nimi olla ka nimisõna, kui need tähistavad klasside perekonda, nt kaart, loend jne.

Süntaks: interface Printable ( //code snippet )

  • Meetodi nimi peaks algama tegusõnaga (määrates toimingu, mida see meetod rakendab) ja alustama väiketähtedest.

Süntaks: void printDetails() ( //code snippet )

  • Kui muutujate puhul peaksid need olema tähenduslikud, mis näitab, millist teavet ta salvestab, olgu see nimi, aadress või telefoninumber jne. Muutujate nimede kirjutamisel peame veenduma, et see ei algavad erisümbolitega, näiteks dollar ($) või alakriipsuga täht (_) ja selle nimes ei tohiks olla tühikuid ja alustatakse väiketähtedega.

Süntaks: int eid, sal;string firstName, lastName;

  • Konstantsete muutujate nimed tuleks kirjutada suurtähtedega (kõik ÜLINÕUD) ja eraldada alakriipsuga (_), selle nimi koosneb enam kui ühest sõnast.

Süntaks: static final int MIN_SAL = 20000;

  • Me teame, et Java kasutab pakettide nimede määramisel kõiki väiketähti ja ka meie paketide nimetamisel peaksime järgima sama nimetamistava.

Süntaks: package src.employeedetails;

  • Java-koodi loendites tuleks kasutada suurtähti, st kõiki suurtähti.

Süntaks: enum JobPost ( MANAGER, ANALYST, HR, ADMIN, ENGINEER )

  • Javas olevad märkused võivad olla nimisõnad, tegusõnad või omadussõnad ning märkuste nimetamisel tuleks järgida pealkirja juhtumistiili.

Süntaks: public @interface Documented ()

Näited Java nimetamise tavades

Kirjutagem nüüd täieliku koodi, kasutades ülaltoodud koodilõike, mis muudab selle tähendusrikkamaks ja aitab meil mõista, miks on rakenduse koodi kirjutamisel mis tahes programmeerimiskeeles oluline järgida nimetamismeetodeid:

Näide nr 1

Kood:

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äljund:

Näide 2

Kood:

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. väljund:

2. väljund:

Java nimetamise tavade eelised

Allpool on mõned java nime nimetamise eelised:

  • Segaduse või eksliku koodi kirjutamise vähendamine kirjalikult.
  • Koodide loetavuse parandamine.
  • Vähem aega, mis kulub koodi välja mõtlemiseks.
  • Koodide hooldatavuse parandamine.
  • Koostage ühtlane kood kogu rakenduse vältel.

Järeldus

Järgmine kord Java-koodi kirjutamise ajal veenduge, et teie määratletud ja rakendatud klassidel, liidestel, pakenditel, meetoditel ja väljadel on nimed, mis järgivad Java nimetamise tavasid. Pidage meeles, et nimetamisreeglite järgimine ükskõik millises programmeerimiskeeles on esimene samm puhta ja järjekindla koodi kirjutamiseks ning on tõenäoliselt esimene parim tava, mida kõik programmeerijad peaksid järgima.

Soovitatavad artiklid

See on Java Naming konventsioonide juhend. Siin käsitleme klasse, liideseid, pakette, meetodeid ja välju, mis määratlevad ja rakendavad Java nimetamise tavasid. Lisateavet leiate ka meie muudest seotud artiklitest -

  1. Objekt PHP-s
  2. Ruudud Java-s
  3. Rekursioon Java-s
  4. Factorial Java
  5. Muutujad JavaScriptis
  6. Massiivid Java programmeerimises
  7. R-pakettide loetelu
  8. Töötavad ja 3 parimat Enumi meetodit C # -s
  9. Factoriali täielik juhend C #

Kategooria:

Tarkvaraarendus