ID : Pass : ｜新規登録｜

パワービーンズ・コーディング規約


Contents

  1. 命名規約
  2. importの宣言
  3. if、while、forの規則
  4. JDBC使用時の規則
  5. JavaDocの規則
  6. EJBクラス名の命名規則


パワービーンズ・コーディング規約

プログラム開発におけるコーディング規約について述べます。

命名規約



ローカル変数名、引数名、クラス名、メソッド名、クラス変数名の命名についての規約。

(1) 共通事項
使用可能文字は半角英数文字とアンダースコアーだけです。
使用可能文字：


(2) ローカル変数名
半角英字の小文字と半角数字のみでアンダースコアー区切りとします。

Note
これはプログラムを第三者が見たときにローカル変数かクラス変数かを
一目で判断できるようにするためです。

例

NG：

OK：


(3) 引数名
半角英字の小文字と半角数字のみでアンダースコアー区切りとします。

Note
これはプログラムを第三者が見たときにローカル変数かクラス変数かを
一目で判断できるようにするためです。

例

NG：

    public ActionForward execute( ActionMapping       actionMapping,
                                  ActionForm          actionForm,
                                  HttpServletRequest  req,
                                  HttpServletResponse res )
        throws IOException, ServletException
    {


OK：

    public ActionForward execute( ActionMapping       action_mapping,
                                  ActionForm          action_form,
                                  HttpServletRequest  req,
                                  HttpServletResponse res )
        throws IOException, ServletException
    {


(4) クラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとします。

例

NG：

public class admMstAccountAction extends WafActionSupport
{
    public ActionForward execute( ActionMapping       mapping,
                                  ActionForm          form,
                                  HttpServletRequest  req,
                                  HttpServletResponse res )
        throws IOException, ServletException
    {


OK：

public class AdmMstAccountAction extends WafActionSupport
{
    public ActionForward execute( ActionMapping       mapping,
                                  ActionForm          form,
                                  HttpServletRequest  req,
                                  HttpServletResponse res )
        throws IOException, ServletException
    {


(5) メソッド名
半角英字の小文字始まりとし、半角英数文字のみで半角英字の大文字区切りとします。

例

NG：

    public void DoStoreAction( HttpServletRequest  req,
                               HttpServletResponse res,
                               AdmMstAccountForm   form )
    {


OK：

    public void doStoreAction( HttpServletRequest  req,
                               HttpServletResponse res,
                               AdmMstAccountForm   form )
    {


(6) クラス変数名
半角英字の小文字始まりとし、半角英数文字のみで半角英字の大文字区切りとします。

Warning
特殊な場合は、この範囲ではない。

例

NG：


OK：




importの宣言



importの制限は"*"で集約せずに個々に宣言すること。


例

NG：

    import javax.ejb.EJBLocalHome;
    import javax.naming.*;
    import javax.servlet.*;


OK：

    import javax.ejb.EJBLocalHome;
    import javax.naming.InitialContext;
    import javax.naming.NamingException;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;




if、while、forの規則



実行するステートメントが1行であっても必ず{}を記述すること。


例

NG：

    if ( !result.next() ) return false;


OK：

    if ( !result.next() ) { return false; }



JDBC使用時の規則



クラス名、メソッド名、クラス変数、ローカル変数、引数の命名についての規約。

(1) ResultSetにて結果を取得する際にカラム・インデックスで取得せずに、カラム名で取得する。

例

NG：

    result.getTimestamp(i++), 
    result.getTimestamp(i++), 
    result.getTimestamp(i++), 
    result.getInt(i++), 
    result.getString(i++),


OK：

    result.getTimestamp("appendDate"), 
    result.getTimestamp("modifyDate"), 
    result.getTimestamp("deleteDate"), 
    result.getInt("deleteKubun"), 
    result.getString("account"),


(2) ResultSet、PreparedStatement、Connectionのクローズの処理
必ず finally で行うこと。

Note
これはExceptionが発生したとき等、必ずクローズ処理が実行するようにするためです。

例

NG：


OK：




JavaDocの規則



必ずクラス、メソッド、クラス変数にはJavaDocを記述してください。

(1) クラス
JavaDocの説明文は「<p>タイトル：〜</p>」、「<p>説明：〜</p>」と言う構成で記述してください。


(2) メソッド
JavaDocの説明文は「<p>タイトル：〜</p>」、「<p>説明：〜</p>」と言う構成で記述してください。
それと、ここでも必ず「@author」を入れてください。



(3) クラス変数
「/**」と「*/」で囲んで記述します。




EJBクラス名の命名規則



EJBクラス名の命名についての規約。

(1) アーカイブファイル名。
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にJARを付ける。

例
AdministratorJAR



(2) エンティティ・ビーンでの display-nameの指定
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にEBを付ける。

例
AdmMstQuestionEB



(3) エンティティ・ビーンでの ejb-nameの指定
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にEJBを付ける。

例
AdmMstQuestionEJB



(4) エンティティ・ビーンでの local-homeのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にLocalHomeを付ける。

例
AdmMstQuestionLocalHome



(5) エンティティ・ビーンでの localのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にLocalを付ける。

例
AdmMstQuestionLocal



(6) エンティティ・ビーンでの ejb-classのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にBeanを付ける。

例
AdmMstQuestionBean



(7) セッション・ビーンでの display-nameの指定
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にSBを付ける。

例
ShoppingControllerSB



(8) セッション・ビーンでの ejb-nameの指定
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にEJBを付ける。

例
ShoppingControllerEJB



(9) セッション・ビーンでの local-homeのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にLocalHomeを付ける。

例
ShoppingControllerLocalHome



(10) セッション・ビーンでの localのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にLocalを付ける。

例
ShoppingControllerLocal



(11) セッション・ビーンでの ejb-classのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にBeanを付ける。

例
ShoppingControllerBean



(12) WEBサービスでの ejb-nameの指定
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にEndpointBeanを付ける。

例
AirlinePOEndpointBean



(13) WEBサービスでの service-endpointのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にIntfを付ける。

例
AirlinePOIntf



(14) WEBサービスでの ejb-classのクラス名
半角英字の大文字始まりとし、半角英数文字のみで半角英字の大文字区切りとし、最後にEndpointBeanを付ける。

例
AirlinePOEndpointBean




プリンタ出力用画面 友達に伝える


投稿された内容の著作権はコメントの投稿者に帰属します。
ユーザ名:

パスワード:


パスワード紛失

新規登録

高度な検索
このサイトは OpenFootStep でアクセス解析中です
Copyright ?�� 2004株式会社パワービーンズ All rights reserved. このサイトへのリンクは自由ですがURLは「http://www.powerbeans.co.jp/」でお願い致します。