Java-Namenskonventionen

In diesem Artikel gehen wir einige Namenskonventionen durch, die insbesondere in Java aus Gründen der Wartbarkeit und Lesbarkeit des Codes befolgt werden sollten, damit ein Programmierer den von einem anderen Programmierer geschriebenen Code verstehen und ändern kann. Wir können es als eine Richtlinie betrachten, die man befolgen kann, wenn man seinen Klassen, Variablen, Methoden oder Schnittstellen usw. Namen zuweist, und die es zu einer guten Praxis beim Schreiben von Codes machen kann. Die Namenskonventionen, die wir in diesem Artikel besprechen, werden von vielen Java-Programmierern vorgeschlagen und praktiziert und auch von Netscape und Sun Microsystems unterstützt.

Syntax in Java-Namenskonventionen

In der Programmiersprache Java wird der Kamel-Schreibstil zum Schreiben von Namen von Methoden/Funktionen, Variablen und dem Titel-Schreibstil für Klassen und Schnittstellen verwendet. Lassen Sie uns die Regeln durchgehen und verstehen, die man bei der Benennung eines Elements/einer Entität in der Java-Programmiersprache befolgen sollte:

Starten Sie Ihren kostenlosen Softwareentwicklungskurs

Webentwicklung, Programmiersprachen, Softwaretests und andere

• Beim Zuweisen von Namen zu Klassen sollten wir bedenken, dass die Klassennamen ein Substantiv sein und mit einem Großbuchstaben beginnen sollten.

Syntax:

public class Employee { //code snippet }

• Im Fall von Schnittstellen sollte es ein Adjektiv ab sein (das das Substantiv beschreibt (eine Klasse, die es implementiert)) und mit einem Großbuchstaben beginnen. In einigen Fällen kann ein Schnittstellenname auch ein Substantiv sein, wenn er eine Klassenfamilie darstellt, z. B. Karte, Liste usw.

Syntax:

interface Printable { //code snippet }

• Ein Methodenname sollte mit einem Verb beginnen (das eine Aktion definiert, die die Methode implementieren soll) und mit einem Kleinbuchstaben beginnen.

Syntax:

void printDetails() { //code snippet }

• Variablen hingegen sollten aussagekräftig sein, was angibt, welche Art von Informationen sie speichert, ob es sich um einen Namen, eine Adresse, eine Telefonnummer usw. handelt. Beim Schreiben von Variablennamen müssen wir sicherstellen, dass dies der Fall ist beginnt nicht mit Sonderzeichen wie einem Dollar ($) oder einem Unterstrich (_) und sein Name sollte keine Leerzeichen enthalten und mit einem Kleinbuchstaben beginnen.

Syntax:

int eid, sal;string firstName, lastName;

• Namen konstanter Variablen sollten vollständig großgeschrieben (alle in GROSSBUCHSTABEN) und durch einen Unterstrich (_) getrennt werden. sein Name besteht aus mehr als einem Wort.

Syntax:

static final int MIN_SAL = 20000;

• Wir wissen, dass Java für die Zuweisung von Paketnamen ausschließlich Kleinbuchstaben verwendet, und wir sollten auch bei der Benennung unserer Pakete derselben Namenskonvention folgen.

Syntax:

package src.employeedetails;

• Aufzählungen in Ihrem Java-Code sollten großgeschrieben werden, d. h. alle Großbuchstaben.

Syntax:

enum JobPost { MANAGER, ANALYST, HR, ADMIN, ENGINEER }

• Anmerkungen in Java können ein Substantiv, ein Verb oder ein Adjektiv sein und sollten bei der Benennung der Anmerkungen der Groß- und Kleinschreibung folgen.

Syntax:

public @interface Documented {}

Beispiele für Java-Namenskonventionen

Lassen Sie uns nun mit den oben genannten Codeausschnitten einen vollständigen Code schreiben, der ihn aussagekräftiger macht und uns hilft zu verstehen, warum das Befolgen von Namenskonventionen beim Schreiben von Anwendungscode in einer beliebigen Programmiersprache wichtig ist:

Beispiel #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();
}
}

Ausgabe:

Beispiel #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 = "[email protected]";
}
// 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","[email protected]");
cust.printDetails();
}
}

Ausgabe 1:

Ausgabe 2:

Vorteile von Java-Namenskonventionen

Im Folgenden sind einige Vorteile der Java-Namenskonvention aufgeführt:

• Reduzierung von Verwirrung beim Schreiben oder fehlerhaftem Code.
• Verbesserung der Lesbarkeit des Codes.
• Weniger Zeitaufwand, um herauszufinden, was der Code bewirkt.
• Verbesserung der Wartbarkeit des Codes.
• Erstellen Sie in der gesamten Anwendung einen konsistenten Code.

Fazit

Stellen Sie beim nächsten Schreiben eines Java-Codes sicher, dass die von Ihnen definierten und implementierten Klassen, Schnittstellen, Pakete, Methoden und Felder Namen haben, die den Java-Namenskonventionen entsprechen. Denken Sie daran, dass das Befolgen von Namenskonventionen in jeder Programmiersprache der erste Schritt zum Schreiben von sauberem und konsistentem Code ist und wahrscheinlich die erste Best Practice, die jeder Programmierer befolgen sollte.

Das obige ist der detaillierte Inhalt vonJava-Namenskonventionen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!