java的代碼規範

一  註釋規則：

1 註釋方式

a //，單行註釋

b,/*HHHHHH*/多行註釋

c,/**HHHHHH*/多行註釋  用於生成javadoc文件

注意：提倡使用/**/這種註釋，慎用單行註釋

2 類，接口說明， 每一個類必須做出說明，類註釋通常類或者接口的前面，類的註釋要包括日期，版本號，作者，模塊的目的和功能

/**

*@

*@
*@

*@

*/

public class Hello

{

}

3方法說明

每一個方法必須進行註釋說明，說明方法的目的/功能，輸出輸入參數和返回值

    /**
     *
     * @param categoryId 根據產品屬於哪個類別來查詢
     * @param name 根據產品的名字
     * @param descr 根據對產品的描述
     * @param lowPrice    根據會員的最低價格
     * @param highPrice 根據會員的最高價格
     * @return 以List<>集合的形式返回給JSP頁面，在遍歷，拿出來要得到的結果
     */
    public  List<Product> searchProducts(int[] categoryId,
                                               String keyWord,
                                               double normalLowPrice,
                                               double normalHighPrice,
                                               double memberLowPrice,
                                               double memberHighPrice,
                                               Timestamp startDate,
                                               Timestamp endDate,
                                               int pageNo,
                                               int page）；

4 類變量，常量說明

每一個類變量，常變量都要進行註釋，說明其意義，作用。

public class HH

{

/**HH*/

public static int HH;

}

開發項目時的命名規則：

包：

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

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

數據庫：
   表名：首字母大寫+駝峯式命名 eg:Article;UserDept
   表中列名：首字母大寫+駝峯式命名 eg:UserId;UnitCost
   存儲過程命名：表名_首字母大寫+駝峯式命名 eg:Admin_UserRegister

項目名稱：
   公認簡寫：全部大寫 eg:DAL;BLL
   其他：首字母大寫+駝峯式命名 eg:DBUtility;OracleDAL

類：
   類名:首字母大寫+駝峯式命名 eg:PetShop.cs;AssemblyInfo.cs
   私有變量名：_首字母小寫+駝峯式命名 eg:_publishTime;_rootCategoryId
   公共屬性名：首字母大寫+駝峯式命名 eg:Description;PublishTime

函數：
   函數名：首字母大寫+駝峯式命名 eg:GetItemByProduct
   參數名：首字母小寫+駝峯式命名 eg:userId,itemInfo