Javaの命名規則

オブジェクト指向プログラミングでは、クラス、オブジェクト、メソッド、変数などに名前を付けるのが非常に上手です。たとえば、大文字と小文字を区別したり、異なる開始文字を使用したりするなどです。しかし、原点に立ち返って、リソースに名前を付けるときは、リソース間に矛盾がなく、それぞれが覚えやすいように、説明性と一意性の 2 つの特性に基づいて名前を付ける必要があります。

パッケージの名前付け

Java パッケージの名前は小文字で構成されます。ただし、Java オブジェクト指向プログラミングの特性により、すべての Java プログラマが独自の Java パッケージを作成できます。最新の Java プログラミング仕様では、各 Java パッケージの名前の一意性を確保するために、プログラマは独自の Java を定義する必要があります。パッケージ名には一意のプレフィックスが付きます。インターネット上のドメイン名は繰り返されないため、プログラマは通常、インターネット上の独自のドメイン名を独自のプログラム パッケージの一意のプレフィックスとして使用します。
例: net.frontfree.javagroup

クラスの名前付け

クラス名は大文字で始まる必要があり、クラス名が複数の単語で構成されている場合は、それぞれの最初の文字が小文字になります。 TestPage のように、単語は大文字にする必要があります。クラス名に略語が含まれる場合は、XMLExample のように、単語の各文字を大文字にする必要があります。クラスはオブジェクトを表すように設計されているため、名前を付けるときにも注意が必要です。分類するときは、名詞を選択するようにしてください。
例: Circle

メソッドの名前付け

メソッド名の最初の単語は小文字で始まり、その後の単語は大文字で始まる必要があります。
例：sendMessge

定数の名前

定数の名前はすべて大文字を使用し、定数の完全な意味を示す必要があります。定数名が複数の単語で構成されている場合は、単語をアンダースコアで区切る必要があります。
例: MAX_VALUE

パラメータの命名規則

パラメータの命名規則はメソッドの命名規則と同じです。プログラムを読む際の混乱を避けるために、パラメータの命名規則をできるだけ明確にしてください。名前は一言です。

Javadoc コメント

一般的なコメント メソッドに加えて、Java 言語仕様では、Javadoc コメントと呼ばれる特別なコメントも定義されており、コード内に API を記録するために使用されます。 Javadoc コメントは、/**皮切りに*/ で終わる複数行のコメントです。コメントには、いくつかの HTML タグと特殊なキーワードを含めることができます。 Javadoc コメントを使用する利点は、書き込まれたコメントが自動的にオンライン ドキュメントに変換され、プログラムのドキュメントを個別に作成する手間が省けることです。
例:

/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/

通常、各プログラムの先頭では、プログラムの全体的な説明と著作権情報を記述するために Javadoc コメントが使用されます。その後、メインプログラム内で、クラス、インターフェイス、メソッドごとに Javadoc コメントを追加できます。各コメントの先頭に、クラス、インターフェイス、メソッド、フィールドによって実行される機能を 1 つの文で要約し、その要約機能を強調表示する必要があります。より詳細な説明の段落。説明段落の後に、Javadoc コメント タグ (上記の例の @auther や @version など) で始まるいくつかの特別な段落が続くこともあります。これらの段落は、生成されたドキュメント内で特定の方法で表示されます。
設計が不十分なプログラムにコメントを追加しても良いプログラムにはなりませんが、プログラムがプログラミング標準に従って書かれており、プログラムに適切なコメントを追加することで、完璧に設計された効率的でわかりやすいプログラムを書くことができます。プログラミングは、特に複数の人が同じプロジェクトで共同作業する場合、さらに重要になります。 「剣を研ぐか木を切るか」ということわざにあるように、Java プログラミング標準に適応するために時間を費やすことは有益です。