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中文网其他相关文章！