Johdanto Java-nimityssopimukseen

Tässä artikkelissa käydään läpi joitain nimeämiskäytäntöjä, joita tulisi noudattaa erityisesti Java-ohjelmissa koodin ylläpitämistä ja luettavuutta varten, jotka auttavat ohjelmoijaa ymmärtämään ja muokkaamaan toisen ohjelmoijan kirjoittamaa koodia. Voimme pitää sitä ohjeena, jota voidaan noudattaa osoittamalla luokkia, muuttujia tai menetelmiä tai rajapintoja jne., Ja tehdä siitä hyvä käytäntö koodien kirjoittamisessa. Monet Java-ohjelmoijat ovat ehdottaneet ja harjoittaneet nimeämiskäytäntöjä, joista keskustelemme tässä artikkelissa, ja niitä tukevat myös Netscape ja Sun Microsystems.

Syntaksi Java-nimeämiskäytännöissä

Java-ohjelmointikielellä kamelilaatikon kirjoitustyyliä käytetään menetelmien / toimintojen nimien, muuttujien ja luokkien ja rajapintojen otsikkotyylin kirjoittamiseen. Tutkitaan ja ymmärretään säännöt, joita tulisi noudattaa nimettäessäsi elementtiä / kokonaisuutta Java-ohjelmointikielellä:

  • Määritettäessä nimiä luokille meidän on pidettävä mielessä, että luokan nimien tulisi olla substantiivi ja alkaa isoilla kirjaimilla.

Syntaksi: public class Employee ( //code snippet )

  • Rajapintojen tapauksessa sen tulee olla ab-adjektiivinen (joka kuvaa substantiivin (luokka, joka toteuttaa sen)) ja alkaa isolla kirjaimella. Joissakin tapauksissa käyttöliittymän nimi voi olla myös substantiivi, kun ne edustavat luokkaperhettä, esim .: Kartta, Lista jne.

Syntaksi: interface Printable ( //code snippet )

  • Menetelmän nimen tulisi alkaa verbillä (määrittelemällä toimenpide, jonka menetelmä toteuttaa) ja aloittamaan pienillä kirjaimilla.

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

  • Muuttujien osalta niiden tulisi olla merkityksellisiä, mikä tarkoittaa, millaisia ​​tietoja se tallentaa, onko nimi, osoite tai puhelinnumero jne. Kun kirjoitat muuttujien nimiä, meidän on varmistettava, että se ei alkaa erikoismerkeillä, kuten dollarilla ($) tai alaviivalla (_), ja sen nimessä ei saa olla välilyöntejä, ja alkaa pienillä kirjaimilla.

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

  • Vakiomuuttujien nimien on oltava isoja isoilla kirjaimilla (kaikki YLIVAIHEET) ja erotettu alaviivalla (_). Sen nimi koostuu useammasta kuin yhdestä sanasta.

Syntaksi: static final int MIN_SAL = 20000;

  • Tiedämme, että Java käyttää pakettien nimien nimeämisessä kaikkia pieniä kirjaimia, ja meidän pitäisi noudattaa samaa nimeämiskäytäntöä myös nimeäessämme paketteja.

Syntaksi: package src.employeedetails;

  • Java-koodisi luettelot tulee kirjoittaa isoilla kirjaimilla, ts. Kaikilla isoilla kirjaimilla.

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

  • Java-merkinnät voivat olla substantiivi, verbi tai adjektiivi, ja niiden tulee noudattaa otsikkotapausta tyylin nimeämiselle.

Syntaksi: public @interface Documented ()

Esimerkkejä Java-nimeämiskäytännöistä

Kirjoita nyt täysi koodi käyttämällä yllä olevia koodinpätkiä, mikä tekee siitä merkityksellisemmän ja auttaa meitä ymmärtämään, miksi seuraavien nimeämiskäytäntöjen merkitys on tärkeä kirjoitettaessa sovelluskoodia mille tahansa ohjelmointikielelle:

Esimerkki # 1

Koodi:

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

lähtö:

Esimerkki 2

Koodi:

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

Lähtö 1:

Lähtö 2:

Java-nimeämiskäytäntöjen edut

Alla on joitain etuja Java-nimeämiskäytännössä:

  • Sekaannuksen tai virheellisen koodin vähentäminen kirjallisesti.
  • Koodin luettavuuden parantaminen.
  • Vähemmän aikaa selvittää, mitä koodi tekee.
  • Koodin ylläpidettävyyden parantaminen.
  • Luo johdonmukainen koodi koko sovelluksen ajan.

johtopäätös

Kun seuraavan kerran kirjoitat Java-koodia, varmista, että määrittelemilläsi ja toteuttamillasi luokilla, rajapinnoilla, paketeilla, menetelmillä ja kentillä on nimet, jotka seuraavat Java-nimeämiskäytäntöjä. Muista, että nimeämiskäytäntöjen noudattaminen millä tahansa ohjelmointikielellä on ensimmäinen askel puhtaan ja johdonmukaisen koodin kirjoittamisessa ja on luultavasti ensimmäinen paras käytäntö, jota kaikkien ohjelmoijien tulisi noudattaa.

Suositellut artikkelit

Tämä on opas Java-nimeämiskäytäntöihin. Tässä keskustellaan luokista, rajapinnoista, paketeista, menetelmistä ja kentistä, jotka määrittelevät ja toteuttavat Java-nimeämiskäytäntöjä. Voit myös käydä läpi muiden aiheeseen liittyvien artikkeleidemme saadaksesi lisätietoja -

  1. Objekti PHP: ssä
  2. Ruudut Java
  3. Rekursio Java-ohjelmassa
  4. Factorial Java
  5. Muuttujat JavaScript
  6. Ryhmät Java-ohjelmoinnissa
  7. Luettelo R-paketeista
  8. Työskentely ja 3 suosituinta enumimenetelmää C #: ssä
  9. Täydellinen opas Factorialiin C #: ssä