Java 命名約定

在本文中，我們將介紹一些應遵循的命名約定，特別是在 Java 中，出於程式碼可維護性和可讀性的目的，幫助程式設計師理解和修改其他程式設計師編寫的程式碼。我們可以將其視為為類別、變數、方法或介面等分配名稱時可以遵循的指南，並使其成為編寫程式碼時的良好實踐。我們將在本文中討論的命名約定是由許多 Java 程式設計師建議和實踐的，並且也得到 Netscape 和 Sun Microsystems 的支援。

Java 命名約定中的語法

在Java程式語言中，駝峰式書寫風格用於書寫方法/函數、變數的名稱以及類別和介面的標題式風格。讓我們回顧一下並了解在 Java 程式語言中命名元素/實體時應遵循的規則：

開始您的免費軟體開發課程

網頁開發、程式語言、軟體測試及其他

• 在為類別指定名稱時，我們應該記住類別名稱應該是名詞並以大寫字母開頭。

文法：

public class Employee { //code snippet }

• 對於接口，它應該是 ab 形容詞（描述名詞（實現它的類別））並以大寫字母開頭。在某些情況下，當介面名稱代表一系列類別時，介面名稱也可以是名詞，例如：Map、List 等。

文法：

interface Printable { //code snippet }

• 方法名稱應以動詞（定義方法將要實現的操作）開頭，並以小寫字母開頭。

文法：

void printDetails() { //code snippet }

• 而對於變數來說，它們應該是有意義的，這表明它儲存的是什麼樣的訊息，是否是姓名、地址、電話號碼等。在編寫變數名稱時，我們需要確保它是不以美元 ($) 或下劃線符號 (_) 等特殊字元開頭，且其名稱不應包含任何空格且以小寫字母開頭。

文法：

int eid, sal;string firstName, lastName;

• 常數變數的名稱應全部大寫（全部大寫）並用下劃線符號（_）分隔；它的名字由多個單字組成。

文法：

static final int MIN_SAL = 20000;

• 我們知道 Java 使用全部小寫字母來指定套件名稱，因此我們在命名套件時也應該遵循相同的命名約定。

文法：

package src.employeedetails;

• java 程式碼中的枚舉應該要大寫，即全部大寫字母。

文法：

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

• java 中的註釋可以是名詞、動詞或形容詞，並且應遵循標題大小寫樣式來命名註釋。

文法：

public @interface Documented {}

Java 命名約定範例

現在，讓我們使用上面的程式碼片段編寫完整的程式碼，使其更有意義，並幫助我們理解為什麼以下命名約定在使用任何程式語言編寫應用程式程式碼時都很重要：

範例#1

代碼：

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

輸出：

範例#2

代碼：

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

輸出 1：

輸出 2：

Java 命名約定的優點

以下是 Java 命名約定的一些優點：

• 減少編寫混亂或錯誤程式碼。
• 提高程式碼可讀性。
• 花更少的時間弄清楚程式碼的作用。
• 提高程式碼可維護性。
• 在整個應用程式中產生一致的程式碼。

結論

下次編寫 Java 程式碼時，請確保您定義和實作的類別、介面、套件、方法和欄位的名稱遵循 Java 命名約定。請記住，在任何程式語言中遵循這些命名約定是編寫乾淨且一致的程式碼的第一步，並且可能是每個程式設計師都應該遵循的第一個最佳實踐。

以上是Java 命名約定的詳細內容。更多資訊請關注PHP中文網其他相關文章！