Inleiding tot naamgevingsconventie in Java

In dit artikel zullen we enkele naamgevingsconventies doorlopen die vooral in Java moeten worden gevolgd voor code-onderhoudbaarheid en leesbaarheid, die een programmeur helpen de code te begrijpen en te wijzigen die door een andere programmeur is geschreven. We kunnen het beschouwen als een richtlijn die men kan volgen bij het toekennen van namen aan iemands klassen, variabele of methoden of interfaces, enz. En het een goede praktijk maken bij het schrijven van codes. De naamgevingsconventies die we in dit artikel zullen bespreken, worden door veel Java-programmeurs voorgesteld en toegepast en worden ook ondersteund door Netscape en Sun Microsystems.

Syntaxis in Java-naamgevingsconventies

In de programmeertaal Java wordt de schrijfstijl van de kameel gebruikt voor het schrijven van namen van methoden / functies, variabelen en de titel van de hoofdletters en kleine letters voor klassen en interfaces. Laten we de regels doornemen die we moeten volgen bij het benoemen van een element / entiteit in Java Programming Language:

  • Bij het toewijzen van namen aan klassen moeten we er rekening mee houden dat de klassennamen een zelfstandig naamwoord moeten zijn en moeten beginnen met een hoofdletter.

Syntaxis: public class Employee ( //code snippet )

  • In het geval van interfaces moet het ab bijvoeglijk naamwoord zijn (dat het zelfstandig naamwoord beschrijft (een klasse die het implementeert)) en beginnen met een hoofdletter. In sommige gevallen kan een interfacenaam ook een zelfstandig naamwoord zijn, wanneer ze een familie van klassen vertegenwoordigen, bijvoorbeeld: kaart, lijst, enz.

Syntaxis: interface Printable ( //code snippet )

  • Een methode naam moet beginnen met een werkwoord (definieert een actie die de methode gaat implementeren) en beginnen met een kleine letter.

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

  • Terwijl voor variabelen betekenisvol moeten zijn, wat betekent wat voor soort informatie wordt opgeslagen, of het nu een naam of een adres of een telefoonnummer is, enz. Bij het schrijven van namen van variabelen moeten we ervoor zorgen dat begin met speciale tekens zoals een dollar ($) of een onderstrepingsteken (_) en de naam mag geen spaties bevatten en beginnen met een kleine letter.

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

  • Namen van constante variabelen moeten volledig in hoofdletters worden geschreven (allemaal HOOFDLETTERS) en worden gescheiden door een onderstrepingsteken (_), de naam bestaat uit meer dan één woord.

Syntaxis: static final int MIN_SAL = 20000;

  • We weten dat Java alle kleine letters gebruikt voor het toewijzen van pakketnamen en we moeten dezelfde naamgevingsconventie volgen bij het benoemen van onze pakketten.

Syntaxis: package src.employeedetails;

  • Tellingen in uw java-code moeten met een hoofdletter worden geschreven, dwz alle hoofdletters.

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

  • Annotaties in Java kunnen een zelfstandig naamwoord, een werkwoord of een bijvoeglijk naamwoord zijn en moeten de titel-case-stijl volgen voor het benoemen van de annotaties.

Syntaxis: public @interface Documented ()

Voorbeelden in Java-naamgevingsconventies

Laten we nu een volledige code schrijven met behulp van de bovenstaande codefragmenten die het zinvoller maakt en ons helpt te begrijpen waarom het volgen van naamgevingsconventies belangrijk zijn bij het schrijven van toepassingscode in elke programmeertaal:

Voorbeeld 1

Code:

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

Output:

Voorbeeld 2

Code:

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

Uitgang 1:

Uitgang 2:

Voordelen van Java-naamgevingsconventies

Hieronder staan ​​enkele voordelen in de Java-naamgevingsconventie:

  • Vermindering van het schrijven van verwarring of foutieve code.
  • Verbetering van de leesbaarheid van de code.
  • Minder tijd besteed om erachter te komen wat de code doet.
  • Verbetering van de onderhoudbaarheid van de code.
  • Produceer een consistente code in de hele applicatie.

Conclusie

Zorg er bij het schrijven van een Java-code voor dat de klassen, interfaces, pakketten, methoden en velden die u definieert en implementeert, namen hebben die voldoen aan de Java-naamgevingsconventies. Onthoud dat de volgende naamgevingsconventies in elke programmeertaal de eerste stap zijn om schone en consistente code te schrijven en waarschijnlijk de eerste best practice is die iedereen moet volgen.

Aanbevolen artikelen

Dit is een handleiding voor Java-naamgevingsconventies. Hier bespreken we de klassen, interfaces, pakketten, methoden en velden die de Java-naamgevingsconventies definiëren en implementeren. U kunt ook onze andere gerelateerde artikelen doornemen voor meer informatie -

  1. Object in PHP
  2. Vierkanten op Java
  3. Recursie in Java
  4. Factorial in Java
  5. Variabelen in JavaScript
  6. Arrays in Java Programming
  7. Lijst met R-pakketten
  8. Werken en Top 3 Enum-methoden in C #
  9. Complete gids voor Factorial in C #

Categorie:

Software ontwikkeling