做開發的都知道，一個好的項目規範可以提高開發效率以及後期的維護。自己手上有個項目，裏面規範很亂，自己在對它進行二次開發的時候很蛋疼，它沒有相應的文檔，公司給我的就只有一個項目源碼，其中的關係還要自己去做調試之後慢慢搞清楚。
今天學習了有關項目的規範教程就寫了這邊文章，請大家多多指教。
----引用尚學堂的
以下是自己感覺比較好的文章就抄過來了：
一、命名規範
1、 項目名全部小寫
2、 包名全部小寫
3、 類名首字母大寫，一般都是使用駝峯式命名。
如：public class MyFirstClass{}
4、同上： 變量名、方法名首字母小寫，如果名稱由多個單詞組成，每個單詞的首字母都要大寫。
如：int index=0;
public void toString(){}
5、 常量名全部大寫
如：public static final String GAME_COLOR=”RED”;
二、註釋規範
1、 類註釋
在每個類前面必須加上類註釋，註釋模板如下：
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 類的詳細說明
*
* @author 類創建者姓名
* @Date 創建日期
* @version 1.00
*/
2、 屬性註釋
在每個屬性前面必須加上屬性註釋，註釋模板如下：
/** 提示信息 */
private String strMsg = null;
3、 方法註釋
在每個方法前面必須加上方法註釋，註釋模板如下：
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 註明從此類方法中拋出異常的說明
*/
4、 構造方法註釋
在每個構造方法前面必須加上註釋，註釋模板如下：
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 註明從此類方法中拋出異常的說明
*/
5、 方法內部註釋
在方法內部使用單行或者多行註釋，該註釋根據實際情況添加。
如：//背景顏色
Color bgColor = Color.RED
6、項目分層命名
一般可以分爲兩種情況進行命名：
A、以功能模塊來分層定義
比如，現有兩個功能模塊User、Menu
com.xxx.user.action com.xxx.menu.action
com.xxx.user.service com.xxx.menu.service
com.xxx.user.dao com.xxx.user.dao
com.xxx.user.controller com.xxx.user.controller
B、以邏輯模塊來劃分
com.xxx.action UserAction MenuAction
com.xxx.service UserService MenuService
