iB2Team項目開發規范

By KevinLee 2016-4-20
僅供參考

1. 目的

為了使軟件開發過程順暢，保證軟件質量，于是有了這份開發規范文檔。

2. 概述

• 項目以功能模塊來劃分分工
• 數據庫不能隨意修改，本地數據庫須統一
• 有標準的Java代碼風格，有良好習慣
• 時刻考慮代碼的可復用性
• 每個人需要有每周項目進度報告

3. 代碼規范

3.1 有關命名

盡量保證能夠通過變量名得知變量的含義

3.1.1 包命名

• 包命名采用全小寫命名
• 通過唯一域名+組件來命名

3.1.2 類命名

• 類命名采用Pascal命名法
• 大寫字母開頭，各個單詞首字母大寫

3.1.3 方法命名

• 方法命名采用Camel命名法
• 小寫字母開頭，各個單詞首字母大寫
• 屬性的getter和setter方法盡量使用自動生成，并放在程序的后面。
• Boolean類型的屬性的get方法應形如isProperty()

3.1.4 變量命名

• 采用Camel命名法
• 小寫字母開頭，各個單詞首字母大寫
• 特有大寫縮寫詞匯保持大寫如：SQL
• 變量名字不宜過長，可適當采用縮減英文元音字母來縮短長度
• 假如縮短后名字重復，可以保留其中一個的部分元音字母

3.1.5 常量命名

• 采用全大寫命名法
  所有字母均大寫

3.1.6 頁面文件命名

• 采用全小寫命名法
• 所有的字母均小寫，單詞之間以下劃線’_’分隔
• 展示頁面，按照名詞+描述，如：news_list.jsp
• 操作頁面，按照名詞+動詞命名，如：news_add.jsp
• 按照模塊從大到小命名，如：news_order_add.jsp

3.1.7 資源文件命名

• 采用全小寫命名法
• 按照前綴+模塊+描述+狀態命名，如：btn_main_login_pressed.png
• (不一定完全包含如上4個部分，但是要依照順序命名)

3.2 有關注釋

團隊成員都應該形成良好的寫注釋的習慣，方便以后閱讀，以及為了后期生成可讀性良好的Java Doc

3.2.1 程序文件頭注釋

應該包含如下：
* 文件描述
* 作者
* 版本
* 創建日期時間
* 修改日期時間
* 參考信息

提前設置好文件的模板Template
如以下模板：

/*** Description: * Author: KevinLee* Version: 1.0* Create Date Time: ${DATE} ${TIME}.* Update Date Time: * @see */

3.2.2 方法頭注釋

一般在寫完一個方法后使用快捷鍵生成一個塊注釋，IDE會自動幫我們寫入一些信息。
應該包含如下信息：
* 方法描述 Description:
* 參數信息 @param
* 返回信息 @return
* 異常信息 @Exception
* 參考信息（可選）@see also //指定一個類或者方法（通過類后面加#選擇方法）
* 筆記信息（可選）Note:
如以下模板：

/*** Description: 返回一個“Hello”字符串* @param str 一個字符串* @return 返回一個字符串* @throws Exception 拋出一個異常* @see com.lidengju.entity.Person* Note: Nothing much.*/ public String sayHello(String str) throws Exception{str="Hello";return str; }

注意：方法里面不要使用塊注釋

3.2.3 關鍵點注釋

應該包含如下信息：
* 一些程序關鍵的地方
* 一些程序不易讀的地方
* 編寫代碼過程中遇到問題的地方
* 需要提示讀者的地方

注釋應該寫得少而易懂
若修改了文件，可以加上修改人的信息，和修改日期。

4. 格式規范

4.1 縮進

應注意使用format來格式化代碼，使用Tab鍵來縮進代碼，相當于4個空格。

4.2 換行

• {}花括號應該另起一行，左花括號與方法名、類名在同一行。(除了數組初始化時的花括號)
• if、while等語句，假如體內只有一句代碼也不要省略{}，為了方便以后的增刪
• 字符串過長考慮拆分成多行

4.3 對齊

• {}括號等應該對齊
• 類和方法的塊注釋必須緊貼類和方法
• 單獨起行的//注釋必須對齊被注釋語句

5. 寫在后面

希望各位成員遵守這份開發規范文檔，養成良好的開發習慣

總結

以上是生活随笔為你收集整理的Java项目开发规范参考的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。