Einführung in die Namenskonvention in Java
In diesem Artikel werden einige Namenskonventionen behandelt, die insbesondere in Java zu Zwecken der Codewartung und Lesbarkeit befolgt werden sollten, damit Programmierer den von einem anderen Programmierer geschriebenen Code besser verstehen und ändern können. Wir können es als Richtlinie betrachten, der man folgen kann, wenn man seinen Klassen, Variablen oder Methoden oder Schnittstellen usw. Namen zuweist, und es zu einer guten Praxis machen, wenn man Codes schreibt. Die in diesem Artikel beschriebenen Namenskonventionen 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 Schreibstil Camel Case zum Schreiben von Namen von Methoden / Funktionen, Variablen und des Schreibstils Title Case für Klassen und Interfaces verwendet. Lassen Sie uns die Regeln durchgehen, nach denen ein Element / eine Entität in Java Programming Language benannt werden muss:
- Beachten Sie beim Zuweisen von Namen zu Klassen, dass die Klassennamen ein Substantiv sein und mit einem Großbuchstaben beginnen sollten.
Syntax: public class Employee ( //code snippet )
- Bei Interfaces sollte es ein Adjektiv 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 sie eine Klassenfamilie darstellen, z. B. Map, List usw.
Syntax: interface Printable ( //code snippet )
- Ein Methodenname sollte mit einem Verb beginnen (was eine von der Methode auszuführende Aktion definiert) und mit einem Kleinbuchstaben beginnen.
Syntax: void printDetails() ( //code snippet )
- Während Variablen aussagekräftig sein sollten, bedeutet dies, welche Art von Informationen gespeichert werden, ob es sich um einen Namen, eine Adresse oder eine Telefonnummer usw. handelt. Wenn Sie Variablennamen schreiben, müssen Sie sicherstellen, dass dies nicht der Fall ist Beginnen Sie mit Sonderzeichen wie einem Dollar ($) oder einem Unterstrich (_). Der Name sollte keine Leerzeichen enthalten und mit einem Kleinbuchstaben beginnen.
Syntax: int eid, sal;string firstName, lastName;
- Namen von konstanten Variablen sollten in Großbuchstaben geschrieben werden (alles in GROSSBUCHSTABEN) und durch ein Unterstrich (_) getrennt sein. Der Name besteht aus mehr als einem Wort.
Syntax: static final int MIN_SAL = 20000;
- Wir wissen, dass Java für die Zuweisung von Paketnamen nur Kleinbuchstaben verwendet, und wir sollten bei der Benennung unserer Pakete dieselbe Namenskonvention befolgen.
Syntax: package src.employeedetails;
- Aufzählungen in Ihrem Java-Code sollten groß geschrieben werden, dh 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 in Groß- und Kleinschreibung geschrieben werden.
Syntax: public @interface Documented ()
Beispiele in Java-Namenskonventionen
Schreiben wir nun einen vollständigen Code mit den obigen Code-Ausschnitten, der aussagekräftiger wird und uns hilft, zu verstehen, warum die folgenden Namenskonventionen beim Schreiben von Anwendungscode in einer beliebigen Programmiersprache wichtig sind:
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 = " ";
)
// 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();
)
)
Ausgang 1:
Ausgang 2:
Vorteile von Java-Namenskonventionen
Im Folgenden sind einige Vorteile der Java-Namenskonvention aufgeführt:
- Reduzierung der Verwechslungsgefahr oder des fehlerhaften Codes.
- Verbesserung der Codelesbarkeit.
- Weniger Zeit, um herauszufinden, was der Code bewirkt.
- Verbesserung der Code-Wartbarkeit.
- 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, Interfaces, Pakete, Methoden und Felder Namen haben, die den Java-Namenskonventionen entsprechen. Denken Sie daran, dass die folgenden Namenskonventionen in jeder Programmiersprache der erste Schritt sind, um sauberen und konsistenten Code zu schreiben. Dies ist wahrscheinlich die erste bewährte Methode, die jeder Programmierer befolgen sollte.
Empfohlene Artikel
Dies ist eine Anleitung zu Java-Namenskonventionen. Hier werden die Klassen, Schnittstellen, Pakete, Methoden und Felder erläutert, die die Java-Namenskonventionen definieren und implementieren. Sie können auch unsere anderen verwandten Artikel durchgehen, um mehr zu erfahren -
- Objekt in PHP
- Quadrate in Java
- Rekursion in Java
- Fakultät in Java
- Variablen in JavaScript
- Arrays in der Java-Programmierung
- Liste der R-Pakete
- Arbeits- und Top-3-Aufzählungsmethoden in C #
- Vollständiger Leitfaden für Factorial in C #