Java開発で守るべきコーディング規約は、大きく分けて以下の7点です。命名規約、コメント規約、インデントと組版規約、ファイル名規約、宣言規約、ステートメント規約、プログラミング規約。
すべての識別子は、ASCII文字、数字、アンダースコア"_"に限定されます。
一意なパッケージ名の接頭辞は常にすべて小文字です。例:
クラス名は大文字と小文字が混在した名詞で、各単語の最初の文字は大文字になります。例えば、Tony。
インターフェースの大文字小文字のルールは、クラス名のルールと似ています。
メソッド名は大文字と小文字が混在した動詞または動詞句で、最初の単語の頭文字は小文字、それ以降の単語の頭文字は大文字になります。たとえば、 setNeekeName(String neekeName) のようになります。
変数名の最初の文字は小文字にし、間に入る単語の最初の文字は大文字にします。変数名は、その名前が示すように、短くて覚えやすいものにしてください。たとえば、neekeName、neekeAddress などです。1 回限りの一時変数を除き、1 文字の変数名は避けてください。
コメントには可能な限り"//"を、すべてのjavadocコメントには"/** /"を、コード・ブロックの一時的なコメントには"/ */"を使用してください。
すべてのソース・ファイルの冒頭には、ファイル名、日付、クラスの機能概要を記したコメントを記述します。
各メソッドにドキュメンテーションコメントを追加する必要があります。
各属性にコメントを追加する必要があります。
コードには少なくとも15％のコメントが含まれています。
60文字以上の行は避けてください。
Eclipseのソースコードの書式設定機能を使用して、コードのインデント・レイアウトを完成させてください。
Javaソース・ファイルには、1つのJavaクラスしか格納できません。
ファイル名はJavaクラス名と同じです。
クラス・ファイルのコード行数は200行以下です。
行で変数を宣言します。
異なるタイプの変数の宣言を同じ行に書かないでください。
変数の宣言はコード・ブロックの先頭でのみ行います。
すべての変数は宣言時に初期化する必要があります。
より高いレベルで宣言された変数を上書きするようなローカル変数の宣言は避けてください。
メソッドは空白行で区切られています。
各行には少なくとも1つの単純な文が含まれています。
return文では、戻り値に括弧を使用しない」文は多重分岐を実装しています。
オブジェクトの状態を設定するメソッドには接頭語として set を、異なるタイプのオブジェクトの状態を取得するメソッドには is を、その他のメソッドを取得するメソッドには get をつけなければなりません。
プログラム中では、数値の使用はできるだけ控えめにし、可能な限り静的変数を定義して数値の意味を示すようにします。プログラムの中で代入や比較が必要な場合は、先に定義した静的変数を使用します。ただし、ループ制御は例外です。
