Java の命名規則

この記事では、特に Java において、コードの保守性と読みやすさを目的として、プログラマーが別のプログラマーが作成したコードを理解して変更するのに役立つ、従うべきいくつかの命名規則について説明します。これは、クラス、変数、メソッド、インターフェイスなどに名前を割り当てるときに従うことができるガイドラインであり、コードを記述するときにそれを良い習慣にすることができます。この記事で説明する命名規則は、多くの Java プログラマによって提案および実践されており、Netscape および Sun Microsystems によってもサポートされています。

Java 命名規則の構文

Java プログラミング言語では、メソッド/関数、変数の名前を記述するためにキャメルケース スタイルが使用され、クラスやインターフェイスのタイトルケース スタイルが使用されます。 Java プログラミング言語で要素/エンティティに名前を付ける際に従うべきルールを理解してみましょう:

無料ソフトウェア開発コースを始めましょう

Web 開発、プログラミング言語、ソフトウェア テスト、その他

• クラスに名前を割り当てるときは、クラス名は名詞であり、大文字で始める必要があることに留意する必要があります。

構文:

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 中国語 Web サイトの他の関連記事を参照してください。