Java開発の命名規則

1. ファイル

1. プロパティ ファイルのサフィックスは、Java の i18n 仕様に準拠しています。
2. 各製品モジュールの設定ファイルは、独自のモジュールの conf ディレクトリに配置する必要があります。ファイル名の必要性 一定の意味があり、名前はオペレーティング システムの要件を満たしている必要があり、英語または中国語のピンインで構成する必要があります。通常のファイルの場合は、アンダースコアを使用できません。言葉の間。

2. 命名規則

2.1 基本ルール

1. 文字セットは、26 文字の英字、0 から 9 までのアラビア数字、およびアンダースコアです。 Javaでは、クラス、フィールド、メソッド、変数、定数は可能な限り文字で表現する必要があります。それ以外の文字は特別な理由がない限り使用できません

2. 名前には何らかの意味を持たせる必要があります。問題のドメインを指定して、名前をある程度簡潔にします。上記は自己記述的なものです
3. 名前が長すぎる場合は、エイリアスまたは略語を使用して名前を簡素化できます。略語には意味が必要であり、これらの略語の意味はプロジェクト全体で維持される必要があります
4. 名前の略語に関するルール (クラス名、フィールド名、変数名、モジュール名などに適用されます)
1) 元の文字をすべて削除します, 繰り返される文字を圧縮します。たとえば、ボタンは btn と省略されます
2) 名前の競合が発生した場合、元のサウンドは特定の省略形で保持されます。たとえば、button は、button と競合しないように、batn と省略されます
5. 名前の先頭にアンダースコアを使用しないでください。また、名前の最後にアンダースコアを使用しないでください

2.2 定数の名前付け規則

1. すべての文字は次のとおりです。大文字にする。意味のある単語の組み合わせを使用して表現し、単語は「_」アンダースコアで区切ります。

2. 名前はできるだけ短くし、16 文字以内にしてください。

プログラム開発中にリテラルを直接操作しないことが最善です。アプリケーションには、次のような特殊な状況でのみ使用できる定数を導入するのが最善です。 for ループで変数を初期化する場合と同様に、-1,0,1 のような定数を直接使用できます

例

publicfinalintMAX_SIZE =120;
publicfinalintMAX_WIDTH =100;
publicfinalString PROPERTY_NAME="menu";

2.3 変数の命名規則

1. 名前の意味が明確でプログラムがそうである場合を除き、名前に数字を使用しないでください。のほうが明確です。インスタンス変数の名前には数字を含めるべきではありません

2. 変数名は名詞です
3. 問題ドメインの意味と一致する単語または単語の組み合わせを使用します。最初の単語はすべて小文字で、後続の各単語の最初の文字は大文字で、残りは小文字です (URL などの特殊な単語を除く)
4. 名前はできるだけ短くし、16 文字以内にしてください
5ライフサイクルが短い一時変数を除く また、変数名として単一文字を使用することは避け、インスタンス変数に名前を付ける場合には単一文字を使用しないでください。整数型などの一般的に使用される単一文字変数は i、j、k、m、n を使用し、文字型は c、d、e を使用し、座標は x、y、z を使用します。
6. 場合によっては、変数に型プレフィックスを追加する必要がある場合があります。すべての型プレフィックスは、変数名の実体部分との間に先頭文字が含まれていてはなりません。クラスのグローバル変数は大文字で残りの単語は小文字にすることを強くお勧めします

publicintwidth;
publicString fileName;
publicstaticApplicationContext context;

2.4 メソッドの命名規則

1. を使用します。問題領域の意味と一致する単語または単語の組み合わせ。最初の単語は小文字、後続の各単語は大文字、残りは小文字です (URL などの特殊な単語を除く) 区切り文字としてアンダースコアを使用しない特別な理由はありません

2. Java の属性メソッドの名前付けは、JavaBean 標準に従います。

1) Getter メソッド: get+属性名、ブール型には is+属性名を使用、一部の特定の属性名は is の代わりに has、can を使用した方が良い場合があります
2) Setter メソッド: set+属性名
3. 命名とクラス構築メソッド 名前は一貫しています

2.5 クラスとインターフェースの命名規則

1. 問題のドメインの意味に一致する単語または単語の組み合わせを使用します。各単語の最初の文字は大文字で、残りの文字は小文字です (特殊なものを除く)。 URL などの単語)

2. インターフェイスの最初の文字は 1 文字を使用します

Example

publicclassFiugre
publicinterfaceFiugreContainer
publicclassStdFigure//std为Standard的缩写

2.6 パッケージの命名規則

1. パッケージ名のすべての文字は小文字です

2. 2 つの文字は使用できません。異なるビジネスの 2 つのパッケージ間では一方向の依存関係になります

3. 論理的な階層構造を採用して依存関係を削減します