javaコーディング规约_rev

《javaコーディング规约_rev》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、―目　次―１．はじめに１２．コーディングの心得２３．プログラムソースの構成３４．コーディング基準３４－１．対象範囲３４－２．ネーミング基準３４－３．ヘッダの記述４４－４．例外処理の記述１４４－５．文１５４－６．インデントと空文字１８５．レビジョン管理１９５－１．バージョン構成１９５－２．修正履歴記述１９６．パッケージについて２０６－１．パッケージ構成２０７．実行環境について２０１８/19１．はじめに本書は、「I社殿向け放管システム」（以下本システムと略す）におけるJAVA言語を使用して開発する部分のコーディング規約を定めたものである

2、。関連図書　I社殿向け放管システム　HTML_JSP_JAVAScritpコーディング規約　　　　　I社殿向け放管システム　ネーミング規約ドキュメンテーションツールとしてJavadocを活用しても問題が無いようにコメントの記載方法に注意する。Javadocの詳しい使い方は、http://java.sun.com/products/jdk/javadoc/index.htmlを参照する。１８/19１．コーディングの心得コーディングとは、プログラム設計において作成された詳細設計書やフローチャート等の論理設計書を基に、機能を計算機で実現す

3、るための論理をプログラミング言語により記述する作業である。コーディングをするにあたり、コーディングレベルに個人差を無くすこと、単体試験への移行をスムーズにすること、保守を容易にすることを考え、以下にコーディングの心構えおよび記述標準をまとめる。（１）システム設計書、詳細設計書（場合によっては、フローチャート等の論理設計書も含む）を基にする。（２）上記ドキュメントの内容をよく理解した上でコーディングする（特に、詳細設計書とコーディングの担当者が異なる場合）。不明確な点は、勝手に判断せず、よく確認しておくこと。（３）理解しやすい（読みや

4、すい）プログラムにすることを第一に心掛ける。そのためには、プログラムの読者を常に頭の中において、読者に説明す　　　　るつもりで書くのが１つのコツである。読んで理解しやすいプログラムは概して品質もよく、改造も容易である。（４）コーディングの途中で設計上の問題が見いだされた場合は、システム設計書／詳細設計書に遡って対処すること。また、勝手に判断せず、　　設計者に確認すること。（５）システムで統一すべきものは、システムで規程したものを用いる。個人では勝手に作成しないこと。変更、改造時のトラブルの元である。（６）コーディング終了後、コードレ

5、ビューを行うこと。コードレビューを十分に行わず安易に次の試験工程に入らない。コードレビューは、もっと　　も手軽な不具合（バグ）検出の手段であるとともに、試験工程で検出しきれないような複雑な不具合を検出できる場合もある。（７）読者の存在を意識してコーディングすること。読者にも、理解し易いプログラムにすることを第一に心掛ける。Rev.1１８/19１．プログラムソースの構成プログラムはクラス単位（外部モジュールから内部モジュール順）に作成する。（１）ヘッダ部（２）クラスの宣言（３）コンストラクタ（４）クラスの変数（属性値）（５）メソッドの

6、ヘッダ（６）メソッドの定義原則として１つのファイルに１つのクラスを定義すること。Rev.1２．コーディング基準JAVAのコーディング基準として、下記の項目を規定する。２－１．対象範囲コーディング規約の対象範囲は以下の通りとする。（７）通常のJAVAのプログラムソースコード（８）JAVAServlet（JServlet）プログラムソースコード（９）JAVABeansプログラムソースコード（１０）JSPソースコード（処理コード部分のみ）２－２．ネーミング基準（１１）Ⅰ社殿向け放管システム　ネーミング規約参照１８/19１－１．ヘッダの記述

7、ヘッダはコメント部分がJAVADOC形式にて出力される。（記述は、/**　・・　*/　となる。）（１）ファイルヘッダCopyright、及びフィル名を記述する。/***********************************************************************(C)CopyrightTOSHIBASolutionsCorp.2005-2006.AllRightsReserved.*[プロジェクトＮＯ]939267*[ソースファイル名]DraftRyohiShinseiServlet.jav

8、a**********************************************************************/packagenuclear.common;importjava.io.*;　　：　　：尚