JAVAコーディング规约_Rev0.docVIP

―目　次― １． はじめに １ ２． コーディングの心得 ２ ３． プログラムソースの構成 ３ ４． コーディング基準 ３ ４－１． 対象範囲 ３ ４－２． ネーミング基準 ３ ４－３． ヘッダの記述 ４ ４－４． 例外処理の記述 １４ ４－５． 文 １５ ４－６． インデントと空文字 １８ ５． レビジョン管理 １９ ５－１． バージョン構成 １９ ５－２． 修正履歴記述 １９ ６． パッケージについて ２０ ６－１． パッケージ構成 ２０ ７． 実行環境について ２０ HTML_JSP_JAVAScritpコーディング規約/products/jdk/javadoc/index.htmlを参照する。 コーディングの心得 コーディングとは、プログラム設計において作成された詳細設計書やフローチャート等の論理設計書を基に、機能を計算機で実現するための論理をプログラミング言語により記述する作業である。 コーディングをするにあたり、コーディングレベルに個人差を無くすこと、単体試験への移行をスムーズにすること、保守を容易にすることを考え、以下にコーディングの心構えおよび記述標準をまとめる。 システム設計書、詳細設計書（場合によっては、フローチャート等の論理設計書も含む）を基にする。 上記ドキュメントの内容をよく理解した上でコーディングする（特に、詳細設計書とコーディングの担当者が異なる場合）。不明確な点 は、勝手に判断せず、よく確認しておくこと。 理解しやすい（読みやすい）プログラムにすることを第一に心掛ける。そのためには、プログラムの読者を常に頭の中において、読者に説明す るつもりで書くのが１つのコツである。読んで理解しやすいプログラムは概して品質もよく、改造も容易である。 コーディングの途中で設計上の問題が見いだされた場合は、システム設計書／詳細設計書に遡って対処すること。また、勝手に判断せず、　　 設計者に確認すること。 システムで統一すべきものは、システムで規程したものを用いる。個人では勝手に作成しないこと。変更、改造時のトラブルの元である。 コーディング終了後、コードレビューを行うこと。コードレビューを十分に行わず安易に次の試験工程に入らない。コードレビューは、もっと　　 も手軽な不具合（バグ）検出の手段であるとともに、試験工程で検出しきれないような複雑な不具合を検出できる場合もある。 読者の存在を意識してコーディングすること。読者にも、理解し易いプログラムにすることを第一に心掛ける。 プログラムソースの構成 プログラムはクラス単位（外部モジュールから内部モジュール順）に作成する。 ヘッダ部 クラスの宣言 コンストラクタ クラスの変数（属性値） メソッドのヘッダ メソッドの定義 原則として１つのファイルに１つのクラスを定義すること。 コーディング基準 JAVAのコーディング基準として、下記の項目を規定する。 対象範囲 コーディング規約の対象範囲は以下の通りとする。 通常のJAVAのプログラムソースコード JAVAServlet（JServlet）プログラムソースコード JAVABeansプログラムソースコード JSPソースコード（処理コード部分のみ） ネーミング基準 Ⅰ社殿向け放管システム　ネーミング規約参照 ヘッダの記述 ヘッダはコメント部分がJAVADOC形式にて出力される。 （記述は、/**　??　*/　となる。） ファイルヘッダ Copyright、及びフィル名を記述する。 /********************************************************************** * C Copyright TOSHIBA Solutions Corp.2005-2006.All Rights Reserved. * [プロジェクトＮＯ] 939267 * [ソースファイル名] DraftRyohiShinseiServlet.java **********************************************************************/ package mon; import java.io.* ; ： ： 尚、リビジョン管理はファイルヘッダ部に記述することとする。 ファイルヘッダ部 /** * * 所属名称取得クラス * 所属名称検索画面を表示する。 * 検索画面にて［選択］ボタン押下時に、選択されている所属データを呼び出し元画面へ渡す。 * *　1.リクエスト情報を取得しセッションチェック処理を呼び出す *　2.取得したリクエスト情報を条件に所属マスタのデータを取得する。 *