【老九学堂】【Java】初級コード規範
3756 ワード
良いコード仕様と習慣はあなたのコードに花を添えると同時に、チームの協力開発の効率を大幅に増加させ、多くの細部の問題を回避し、コードの読解性を大幅に向上させ、優秀な開発者の必須スキルの一つでもあるので、次に、一般的なコード仕様を理解し、把握しましょう.
一、命名規範:
クラス名の頭文字は大文字でなければなりません.すべてのメンバー変数、メソッドのネーミングは、ラクダネーミング法を遵守する必要があります.【PS:駱駝式命名法は、変数名または函式名が1つ以上の単語で連結された唯一の識別字である場合、最初の単語は小文字で始まる.2番目の単語の頭文字の大文字または各単語の頭文字は大文字の母を採用する.例えば、myFirstName、myLastNameのような変数名は駱駝峰のように見える彼伏を起こしたので、ラクダの命名法と呼ばれ、ラクダの峰の命名とも呼ばれています.
例:
openAccount();save(); getFirstName();isAtEnd();
一般演算子の両方には、スペース+、-、*、/、%、=、!=、<=、>=が必要です.2つのスペース:
String name = “zn”; 2 – 1; 2 + 1; 2 * 1; 2/1; 2 % 1; 2 > 1; 2 > 1; 2 != 1; 2 <= 1; 2 >= 1;
一元演算は除外できます.例えば、i++;i–;++i; --i; 書き込み{}は次の形式で記述されています.
抽象クラスはAbstractで始まる.
public class AbstractCollection
インタフェースの実装はImplエンドを使用する.
public class IteratorImpl implements Iterator
静的可変変数はすべて大文字で、単語間は_区切り:
public static final int MAX_VALUE = 5;
パッケージ名は小文字と少量の数字で構成され、パッケージ名はモジュールの適切な意味を表す英語の単語や略語で統一されている.例えば、老九学堂のプロジェクトはこのように命名されています.パッケージ名は1級comです.パッケージ名の2級はxuetang 9である.パッケージ名の3級はクラス番号、prot 001である.パッケージ名の4級はcrazyなどのグループ名です.パッケージ名の5級は機能モジュールによって区分され、oofoodなどである.パッケージ名はcom.xuetang 9.prot 001.crazy.oofood
二、注釈要求
注釈はプログラムの読者を助ける手段であり、符号化の過程でいつでも注釈を付けなければならず、後で補完することはできない.注釈を通じて当時の構想、および懸案の問題を説明する.プログラムの可読性、規範性、メンテナンス性を向上させる.使用説明、および構成情報を提供します.1.各行の注釈は40文字を超えない.2.各クラス、インタフェースの先頭には、作成者、バージョン、作成時間など、中国語の注釈を使用する複数行の詳細な機能説明が必要です.3.各メソッドの前にJavadocの中国語注釈を使用しなければならない.このメソッドの役割と目的を説明しなければならない.4.各メンバー変数には、単一の中国語コメントが必要であり、そのメンバー変数の役割と目的を説明する必要があります.
クラスコメント
メソッドコメント
メソッドヘッダコメントには、メソッドがどのような機能を実行しているのか、なぜこのように処理しているのか、メソッド処理中にオブジェクトのプロパティを変更する可能性があります.メソッド実行前後、オブジェクトの状態.
1.比較、循環などの制御構造に注釈を付けなければならない.2.コードの機能が一目瞭然でない場合、なぜそうするのかを説明しなければならない.3.ローカル変数に注釈を付けなければならない.4.複雑で書きにくいコードには注釈を付けなければならない.5.一連のコードの前後の実行順序に要求がある場合、説明方法の先頭に必要な注釈内容:作成者、機能、パラメータの説明、戻り値、例外、日付、修正日、修正者、修正原因を注釈しなければならない.例:
変数コメント
すべての変数(ドメイン)へのコメントが必要です.次のようになります.
インストールに問題が発生した場合、九君個人QQ:614940318を追加することができます.CSDN老九学堂からの無料C、C++、Java課程の住所をメモしてください.https://study.163.com/courses-search?keyword=老九学堂
一、命名規範:
クラス名の頭文字は大文字でなければなりません.すべてのメンバー変数、メソッドのネーミングは、ラクダネーミング法を遵守する必要があります.【PS:駱駝式命名法は、変数名または函式名が1つ以上の単語で連結された唯一の識別字である場合、最初の単語は小文字で始まる.2番目の単語の頭文字の大文字または各単語の頭文字は大文字の母を採用する.例えば、myFirstName、myLastNameのような変数名は駱駝峰のように見える彼伏を起こしたので、ラクダの命名法と呼ばれ、ラクダの峰の命名とも呼ばれています.
例:
openAccount();save(); getFirstName();isAtEnd();
一般演算子の両方には、スペース+、-、*、/、%、=、!=、<=、>=が必要です.2つのスペース:
String name = “zn”; 2 – 1; 2 + 1; 2 * 1; 2/1; 2 % 1; 2 > 1; 2 > 1; 2 != 1; 2 <= 1; 2 >= 1;
一元演算は除外できます.例えば、i++;i–;++i; --i; 書き込み{}は次の形式で記述されています.
public interface Interface {
public void showMessage() {
}
}
抽象クラスはAbstractで始まる.
public class AbstractCollection
インタフェースの実装はImplエンドを使用する.
public class IteratorImpl implements Iterator
静的可変変数はすべて大文字で、単語間は_区切り:
public static final int MAX_VALUE = 5;
パッケージ名は小文字と少量の数字で構成され、パッケージ名はモジュールの適切な意味を表す英語の単語や略語で統一されている.例えば、老九学堂のプロジェクトはこのように命名されています.パッケージ名は1級comです.パッケージ名の2級はxuetang 9である.パッケージ名の3級はクラス番号、prot 001である.パッケージ名の4級はcrazyなどのグループ名です.パッケージ名の5級は機能モジュールによって区分され、oofoodなどである.パッケージ名はcom.xuetang 9.prot 001.crazy.oofood
二、注釈要求
注釈はプログラムの読者を助ける手段であり、符号化の過程でいつでも注釈を付けなければならず、後で補完することはできない.注釈を通じて当時の構想、および懸案の問題を説明する.プログラムの可読性、規範性、メンテナンス性を向上させる.使用説明、および構成情報を提供します.1.各行の注釈は40文字を超えない.2.各クラス、インタフェースの先頭には、作成者、バージョン、作成時間など、中国語の注釈を使用する複数行の詳細な機能説明が必要です.3.各メソッドの前にJavadocの中国語注釈を使用しなければならない.このメソッドの役割と目的を説明しなければならない.4.各メンバー変数には、単一の中国語コメントが必要であり、そのメンバー変数の役割と目的を説明する必要があります.
クラスコメント
/*** ：
* ：
* ：2017-06-01
*/
メソッドコメント
メソッドヘッダコメントには、メソッドがどのような機能を実行しているのか、なぜこのように処理しているのか、メソッド処理中にオブジェクトのプロパティを変更する可能性があります.メソッド実行前後、オブジェクトの状態.
1.比較、循環などの制御構造に注釈を付けなければならない.2.コードの機能が一目瞭然でない場合、なぜそうするのかを説明しなければならない.3.ローカル変数に注釈を付けなければならない.4.複雑で書きにくいコードには注釈を付けなければならない.5.一連のコードの前後の実行順序に要求がある場合、説明方法の先頭に必要な注釈内容:作成者、機能、パラメータの説明、戻り値、例外、日付、修正日、修正者、修正原因を注釈しなければならない.例:
/*** ：
* ：
* ： voCond： VO voAstCond： VO
* ：ResultVO：
* ：DatabaseException
* ：2017-06-01
* ， ， ， ：
* 2017-06-16, ， ，lisi_start/lisi_end
* 2017-07-16, ， ，wangwu_start/wangwu_end
*/
変数コメント
すべての変数(ドメイン)へのコメントが必要です.次のようになります.
/** */
private String title = null;
/** VO */
private PurchaseBillVO purchaseBillVO = null;
javadoc ： ：
//
private String title = null;
// VO
private PurchaseBillVO purchaseBillVO = null;
インストールに問題が発生した場合、九君個人QQ:614940318を追加することができます.CSDN老九学堂からの無料C、C++、Java課程の住所をメモしてください.https://study.163.com/courses-search?keyword=老九学堂