J2EE專案程式碼編寫規範分享

碼編寫規範目的：能夠在編碼過程中實現規範化，為以後的程式開發中養成良好的行為習慣。
程式碼編寫規範使用範圍：J2EE專案開發。

包命名規範：
目的：包的命名規範應當體現出專案資源良好的劃分

servlet類所在包命名規範：公司名稱.開發組名稱.專案名稱.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所在包命名規範：公司名稱.開發組名稱.專案名稱.web.struts.service.impl
例如：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類命名：
命名規範：以Servlet單詞結尾
例如：LoginServlet

POJO命名：
使用hibernate自動生成的類即可

DAO類命名：
使用hibernate自動生成的類即可

Action類命名：
命名規範：Action的命名以POJO名稱來制定，POJO名稱Action
例如：
一個POJO名稱為Diary，其對應的action為DiaryAction

ActionForm類命名：
命名規範：ActionForm的命名以POJO名稱來制定，POJO名稱Form
例如：
一個POJO名稱為Diary，其對應的actioForm為DiaryForm

業務邏輯介面命名:
命名規範：業務邏輯介面的命名以POJO名稱來制定，IPOJO名稱Service
例如：
一個POJO名稱為Diary，其對應的業務邏輯介面為IDiaryService

業務邏輯實現類命名:
命名規範：業務邏輯介面實現類的命名以POJO名稱來制定
例如：
一個POJO名稱為Diary，對應的業務邏輯介面實現類名為DiaryServiceImpl

類變數命名：
命名規範：變數名首字母必須小寫，如果該變數名有多個單片語成，後面的單詞首字母大寫，單詞與單詞之間不要使用"_"做連線，變數名訪問控制必須為私有，可以對其增加setter與getter方法。
例如：private int studentAge;
public int getStudentAge()
{
return studentAge;
}

public void setStudentAge(int studentAge)
{
this.studentAge=studentAge;
}

常量命名：
命名規範：所有字母大寫，如果有多個單片語成，單詞與單詞之間以” _“隔開。而且該變數必須是公共、靜態、final型別
例如：public static final String USER_NAME=”userName“;

方法命名
命名規範：首字母必須小寫，如果該變數名有多個單片語成，後面的單詞首字母大寫，單詞與單詞之間不要使用"_"做連線。單詞不要使用名詞。
例如：public int checkLogin（String name,String pwd）{}

註釋規範：註釋規範是整個開發規範中最為重要的組成部分，必須嚴格執行。
類的註釋：
作用：註釋整個類，簡單概述該類作用。
書寫規範：類的註釋必須寫在該類的宣告語法之前。在註釋中要描述該類的基本作用，作者，日期，版本，公司名稱，版權宣告。
格式：
/* *
* 類功能描述：（大致描述類的功能）
* @author：編寫者名稱
*
* @version：類檔案的版本號從1.0開始（自己確定版本號的增改
*   情況），修改情況（修改時間、作者、改動情況）
*
* @see 包名.參考類名（列出父類，引入類，每個類佔一行），如果有
* 可省略
* 相關資料如：（便於理解本類的一些常量資料及某些資料的格式
*   或認為比較重要的資料，如果沒有可省略）
*/
類的宣告語法
例如：
/**
      *

Title:管理員模組資料處理類

*
Description: 兩個數相加

*
Company:華騰軟體公司

*
* @author 童金虎
*
* @version $Revision: 1.7 $ $Date: 2007/07/08$
*/
public class AdminDAO

變數、常量註釋：
作用：簡單描述該變數的意義。
書寫規範：變數註釋必須寫在變數定義之前，簡單描述其代表的意義。
格式：
/**
* 變數功能描述：（大致描述變數的功能）
*/
例如：
    /**
      *定義年齡變數
      */
public int age;

方法註釋：
作用：對該方法功能簡單描述，其引數、返回值意義的註解。
書寫規範：方法註釋必須寫在方法定義之前。該註釋包括：方法其功能的簡單描述，方法的引數、返回值型別、返回值意義簡單的描述。
格式：
        /**
   * 方法功能說明
   * @param args (引數型別可以寫在引數後，也可以省
   *   略。每個引數佔一行)
   * @return 輸出引數（多種情況寫在同一行）
   * @see 類#參考方法（與此方法有呼叫關係的方法供參
   *   考，不必每個方法都完整列出，要選擇有意義的，每個
   *   方法佔一行）
   * @exception 異常處理類（方法中能夠引發的異常，每
   *   個異常佔一行）
*/
例如：
/**
* 修改管理員密碼
* @param adminId 管理員編號
* @param oldPassword 舊密碼
* @param password 新密碼
* @return boolean 是否編輯成功
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
String password) throws UserException,ServiceException;

Jsp頁面命名：
命名規範：jsp頁面名稱要以小寫字母開頭，如果有多個單片語成，後面的單詞以大寫字母開頭。名稱要體現出該頁面的意義，最好能夠與模組名稱聯絡在一起。
例如：
login.jsp --登入頁面
register.jsp --註冊頁面
message.jsp --客戶留言頁面

J2EE專案工程資料夾組織規範：
目的：規範學員web應用程式的資源組織形式，形成良好的檔案組織習慣。檔案的組織形式應當體現模組的劃分。
根據eclipse工具的特徵，專案的目錄結構為：

J2EE專案提交規範
專案完成時要將專案作為一個產品交付使用者，良好的專案組織規範可以使使用者可以方便的找尋專案中需要的資源，同時也是一個公司專業性的體現。專案提交時，要按照下列檔案格式進行提交。

專案主資料夾：
作用：存放專案其他資原始檔。
命名規範：時間_班級編號_第X小組。
例如：070706_GS2T18_第四小組。

注：一個完整的專案中，資料庫必須有一定量的有效的測試資料來支援該程式的執行

J2EE專案程式碼編寫規範分享

相關文章