コード記述標準の目的は、コーディング プロセスの標準化を達成し、将来のプログラム開発のための適切な行動習慣を身に付けることです。
コード記述仕様の利用範囲：J2EEプロジェクト開発。
パッケージの命名規則:
目的: パッケージの命名規則は、プロジェクト リソースの適切な分割を反映する必要があります。
サーブレット クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.web.servlet
例: net.linkcn.web.servlet
カスタム タグ クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.web.tags
例: net.linkcn.web.tags
フィルター クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.web.filter
例: net.linkcn.web.filter
Action クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.web.struts.action
例: net.linkcn.web.struts.action
ActionForm クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.web.struts.form
例: net.linkcn.web.struts.form
Javabean パッケージの命名規則: 会社名、プロジェクト名。
例: net.linkcn.web.service.impl
Javabean実装インターフェースの命名規則：会社名.開発グループ名.プロジェクト名.web.service
例: net.linkcn.web.service
DAO クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.dao.impl
例: net.linkcn.dao.impl
DAO クラスによって実装されるインターフェイスには、パッケージ内に会社名.開発グループ名.プロジェクト名.dao という命名規則があります。
例: net.linkcn.dao
POJO クラスと hbm ファイルが配置されているパッケージの命名規則: 会社名.dao.hbm。
例: net.linkcn.dao.hbm
グローバル パブリック クラスとインターフェイス クラスが配置されるパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.global
例: net.linkcn.global
グローバル ツール クラスが配置されているパッケージの命名規則: 会社名.開発グループ名.プロジェクト名.util
例: net.linkcn.util
クラスの命名規則 基本的な命名規則:
クラスとインターフェイスの命名規則: 複数の単語がある場合は、各単語の最初の文字を大文字にします。例: StudentInfo。
インターフェイスの命名規則: 大文字の「I」で始めます。複数の単語がある場合は、各単語の最初の文字を大文字にします。例: IStudentInfo。
インターフェース実装クラスの命名:
命名規則: 実装されたインターフェイス名の最初の文字「I」を削除し、「Impl」で終わります。複数の単語がある場合は、各単語の最初の文字を大文字にします。
例: StudentInfoImpl
J2EE+SSH フレームワークの命名規則
サーブレットクラスの命名:
命名規則: Servlet という単語で終わります。例: LoginServlet。
POJO の命名:
Hibernateによって自動的に生成されたクラスを使用するだけです
DAO クラスの命名:
Hibernateによって自動的に生成されたクラスを使用するだけです
アクションクラスの命名:
命名規則: アクションの命名は POJO 名、POJO 名アクションに基づいています。
例えば：
POJO 名は Diary で、対応するアクションは DiaryAction です。
ActionForm クラスの命名:
命名規則: ActionForm の命名は、POJO 名と POJO 名のフォームによって決まります。
例えば：
POJO 名は Diary で、それに対応する actioForm は DiaryForm です。
ビジネス ロジック インターフェイスの名前付け:
命名規則: ビジネス ロジック インターフェイスの命名は POJO 名によって決まり、IPOJO 名は Service です。
例えば：
POJO 名は Diary で、それに対応するビジネス ロジック インターフェイスは IDiaryService です。
ビジネス ロジック実装クラスの命名:
命名規則: ビジネス ロジック インターフェイス実装クラスの命名は、POJO 名に基づいています。次に例を示します。
POJO の名前は Diary で、対応するビジネス ロジック インターフェイス実装クラスの名前は DiaryServiceImpl です。
クラス変数の命名:
命名規則: 変数名の最初の文字は小文字にする必要があります。変数名が複数の単語で構成される場合、単語を接続するために「_」を使用しないでください。変数名はプライベートである必要があります。setter メソッドと getter メソッドを追加できます。
例: private int StudentAge;
public int getStudentAge()
{
帰国生の年齢;
}
public void setStudentAge(int StudentAge)
{
this.studentAge=学生年齢;
}
定数の名前付け:
命名規則: すべての文字は大文字で指定します。複数の単語がある場合は、単語を「_」で区切ります。また、変数は public、static、final 型である必要があります。例: public static Final String USER_NAME=”userName”;
メソッドの命名規則: 変数名が複数の単語で構成される場合、最初の文字は大文字にする必要があります。単語を接続するために「_」を使用しないでください。単語に名詞を使用しないでください。
例: public int checkLogin(String name,String pwd){}
アノテーション仕様: アノテーション仕様は開発仕様全体の最も重要なコンポーネントであり、厳密に実装する必要があります。
授業ノート:
機能: クラス全体に注釈を付け、クラスの機能の概要を簡単に説明します。
記述規則: クラスのアノテーションは、クラスの宣言構文の前に記述する必要があります。コメントには、クラスの基本機能、作成者、日付、バージョン、会社名、著作権表示を記述します。
形式：
/* *
* クラス関数の説明：（クラスの機能を大まかに説明します）
* @author: 著者名
*
* @version: クラスファイルのバージョン番号は1.0から始まります(バージョン番号の追加や変更は自分で判断してください)
※状況）、変更状況（変更時刻、作成者、変更状況）
*
* @参照クラス名 (親クラスのリスト、クラスの導入、各クラスが 1 行を占める) (存在する場合)
*省略可能
* 次のような関連データ: (このクラスの一部の定数データと一部のデータの形式を理解しやすくするため)
※または重要と思われるデータ、入手できない場合は省略可能）
*/
クラス宣言の構文は次のとおりです。
/**
*
タイトル:管理者モジュール データ処理クラス
*
説明: 2 つの数値を加算します。
*
著作権: 著作権 (c) 2007
*
会社名:華騰ソフトウェア会社
*
* @著者 トン・ジンフ
*
* @version $リビジョン: 1.7 $ $日付: 2007/07/08$
*/
パブリッククラスAdminDAO
可変コメントと定数コメント:
機能: この変数の意味を簡単に説明します。
記述基準: 変数コメントは変数定義の前に記述し、その意味を簡単に説明する必要があります。
形式：
/**
* 変数関数の説明: (変数の関数を大まかに説明します)
*/
例えば：
/**
*年齢変数を定義する
*/
公的整数年齢。
メソッドのコメント:
機能: メソッドの機能の簡単な説明、パラメータと戻り値の意味に関する注釈。
記述規則: メソッド コメントはメソッド定義の前に記述する必要があります。注釈には、メソッドの機能の簡単な説明、メソッドのパラメータの簡単な説明、戻り値の型、および戻り値の意味が含まれます。
形式：
/**
*メソッド機能の説明
* @param args (パラメータの型はパラメータの後に記述できます、または省略できます)
* 省略。各パラメータは 1 行を占めます)
* @return 出力パラメータ (複数のシチュエーションを同じ行に記述)
* @see class #reference メソッド (このメソッドの呼び出しに関連するメソッドは参考用です)
* 試験では、すべての方法をすべて列挙する必要はありません。意味のあるものを選択する必要があります。
※メソッドは1行になります）
* @Exception 例外処理クラス (メソッド内でスローできる例外、それぞれ
※例外は1行になります）
*/
例えば：
/**
* 管理者パスワードの変更
* @param adminId 管理者番号
* @param oldPassword 古いパスワード
* @param パスワード 新しいパスワード
* @return boolean 編集が成功したかどうか
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
文字列パスワード）UserException、ServiceExceptionをスローします。
JSP ページの命名:
命名規則: JSP ページ名は小文字で始まる必要があります。複数の単語で構成される場合、後続の単語は大文字で始める必要があります。名前はページの意味を反映する必要があり、できればモジュール名にリンクする必要があります。
例えば：
login.jsp --ログインページ
register.jsp -- 登録ページ
message.jsp -- 顧客メッセージ ページ
J2EE プロジェクトのプロジェクト フォルダー構成の仕様:
目的: 学生の Web アプリケーションのリソース編成形式を標準化し、適切なファイル編成習慣を形成すること。ドキュメントの構成には、モジュールへの分割が反映されている必要があります。
Eclipse ツールの特性に従って、プロジェクトのディレクトリ構造は次のとおりです。
送信元
----Java ファイルの保存
ウェブルート
|--images --Web プログラムに必要なパブリック イメージを保存します
|--css -- Web プログラムに必要なパブリック スタイル シートを保存します。
|--js --Web プログラムに必要なパブリック js ファイルを保存します。
|--commons --Web プログラムに必要なパブリック ファイルを保存します
|-- 機能モジュールフォルダ (特定の機能モジュールに関連するリソースを格納するため)
|--images --この汎用モジュールに関連するイメージを保存します
|--css --このモジュールに関連するスタイル シート ファイルを保存します。
|--js --このモジュールに関連する js ファイルを保存します
|--jsp、html ページ
|--WEB-INF
|--クラス
|--lib
|--tld ファイル
J2EE プロジェクトの提出仕様 プロジェクトが完了したら、プロジェクトを製品としてユーザーに提供する必要があります。適切なプロジェクト構成仕様により、ユーザーはプロジェクトに必要なリソースを簡単に見つけることができ、また、企業のプロフェッショナリズムを反映できます。プロジェクトを提出する場合は、以下のファイル形式で提出する必要があります。
プロジェクトのメインフォルダー:
機能: プロジェクトの他のリソース ファイルを保存します。
命名規則: time_class number_group X.
例: 070706_GS2T18_グループ 4。
プロジェクトのメイン フォルダーには、次のフォルダーとファイルが含まれています。
|--src: .java ファイルを保存します。
|--database: データベースのスクリプト ファイルまたはデータベース バックアップ ファイルを保存します。
|--source: Eclipse プロジェクトの WebRoot ディレクトリ内のすべてのファイルを保存します。
|--depend: プログラムをコンパイルするために依存する必要がある他の jar ファイルを保存します。
|--javadoc: すべてのクラスによって生成された javadoc API ドキュメントを保存します。
|--war: プログラムを保存するアーカイブ ファイル
|--xx.war: プロジェクト ファイルはパッケージ化されており、直接実行できます。
|--project: 開発プロジェクトの元のエンジニアリング コードとファイルを保存します。
|--製品マニュアル.doc: 製品の使用方法を画像とテキストで示します。
|--build.xml: 実行中の war ファイルの生成に使用される ant スクリプト。
|--プロジェクト説明.ppt: プロジェクト説明用の ppt (ppt は学校シミュレーション プロジェクトでのみ使用され、他の商業目的には使用されません)
注: 完全なプロジェクトでは、プログラムの動作をサポートするためにデータベースに一定量の有効なテスト データが必要です。