Java開発のコード仕様を詳しく解説

Java開発において従うべきコーディング標準には、一般的に以下の7点が含まれます。ネーミング仕様、コメント仕様、インデント形式仕様、ファイル名仕様、宣言仕様、ステートメント仕様、およびプログラミング仕様。 [推奨学習: Java ビデオ チュートリアル ]

1. 命名規則

(1) すべて識別子には、ASCⅡ文字 (A ～ Z または a ～ z)、数字 (0 ～ 9)、およびアンダースコア「_」のみを使用できます。

(2) 一意のパッケージ名の接頭辞は常にすべて小文字です。例: www.tonysun.cc

(3) クラス名は名詞であり、大文字と小文字が混合され、各単語の最初の文字が大文字になります。例: トニー。

(4) インターフェイスの大文字と小文字の規則はクラス名と似ています (例: Tony)。

(5) メソッド名は、大文字と小文字が混合された動詞または動詞句であり、最初の単語の最初の文字が小文字で、後続の単語の最初の文字が大文字になります。例: setNeekeName(String&neekeName)。

(6) 変数名の最初の文字は小文字で、中間の単語の最初の文字は大文字になります。変数名は短くて覚えやすいものにする必要があります。例: neekeName、neekeAddress。 1 回限りの一時変数を除き、単一文字の変数名は避けてください。

(7) 定数の宣言はすべて大文字で、各単語を "_" で区切って宣言します。例:final&String&WWW_TONY_CN&=&"www.tonysun.cc";

2. コメントの仕様

(1) コメントを次のように使用します。可能な限り「//」を使用し、すべての javadoc コメントには「/**&*/」を使用し、コード ブロックの一時的なコメントには「/*&*/」を使用するようにしてください。

(2) すべてのソース ファイルの先頭には、ファイル名、日付、クラスの機能概要をリストしたコメントが必要です。

(3) ドキュメントのコメントを各メソッドに追加する必要があります (クラスの main() メソッドを除く)。

(4) 各属性にはコメントを付ける必要があります。

(5) コードには少なくとも 15% のコメントが含まれています。

(6) コメントは中国語です。

3. インデント組版仕様

(1) 60 文字を超える行は避けてください。

(2) Eclipse のソースコード整形機能を使用して、コードのインデントを完了します (Ctrl Shift F)。

4. ファイル名の仕様

(1) Java ソースファイルには Java クラスを 1 つだけ格納できます。

(2) ファイル名はJavaクラス名と同じです。

(3) クラス ファイルのコード行数は 200 行を超えてはなりません。

5. 宣言仕様

(1) 変数を1行で宣言します。

(2) 異なる型の変数の宣言を同一行に記述しないでください。

(3) 変数はコード ブロックの先頭でのみ宣言してください。

(4) すべての変数は宣言時に初期化する必要があります。

(5) 宣言されたローカル変数が前のレベルで宣言された変数を上書きしないようにします。

(6) メソッドは空白行で区切られます。

6. ステートメントの仕様

(1) 各行には少なくとも 1 つの単純なステートメントが含まれます。

(2) return文内で戻り値が括弧「()」で囲まれていません。

(3) If 文は必ず「{」と「}」で囲みます。

(4) for ステートメントの初期化句または更新句では、3 つ以上の変数を使用することによって複雑さが増すことを避けてください。

(5) switchの場合を下方向に実行する場合(break文がないため)、通常はbreak文の位置にコメントを追加します。

7. プログラミング仕様

(1) インスタンスおよびクラス変数にパブリックまたはプライベートのアクセス制御を提供し、デフォルト値や保護されたアクセス制御を適用しないでください。できるだけ。

(2) オブジェクトを使用してクラスの静的変数またはメソッドにアクセスすることは避けてください。代わりにクラス名を使用する必要があります。

(3) 1 つのステートメント内で複数の変数に同じ値を代入することは避けてください。

(4) switch() ステートメントを使用して、多方向分岐を実装します。

(5) JDBC を使用する場合は、java.sql.Statement の代わりに java.sql.PreparedStatement の使用を検討してください。

(6) オブジェクトの状態を設定するために使用されるメソッドの接頭辞は設定されている必要があり、ブール型オブジェクトの状態を取得するために使用されるメソッドの接頭辞は is である必要があり、他のメソッドを取得するために使用されるメソッドは get である必要があります。

(7) プログラム内での数値 (または文字) の使用はできる限り少なくし、数値 (または文字) の意味を説明するために静的変数をできる限り定義する必要があります。プログラム内で代入や比較が必要な場合は、あらかじめ定義した静的変数を使用します。ループ制御で例外が発生しました。

この記事は Java 入門 列からのものです。ぜひ学習してください。

以上がJava開発のコード仕様を詳しく解説の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。