JAVA注釋規範

標籤：java、java注釋、java注釋規範

勢航車連網平台（CVNAVI）開發平台方面代碼規範

一、Java代碼

1、注釋

類頭、方法頭必須添加註釋，例如：

/**

 * @ClassName: Enterprise

 * @Description: TODO(企業互動)

 * @author: 阮啟偉

 * @company: 上海勢航網路科技有限公司

 * @date 2017年7月6日 下午3:33:39

 */

public class Enterprise {

@Autowired

   private IEnterpriseService iEnterpriseService;

/**

* @Title: insert

* @Description: TODO(企業添加)

* @param @return

* @param @throws IOException    設定檔案

* @return String    傳回型別

* @author: 阮啟偉

* @date 2017年7月6日 下午3:35:18

* @throws

*/

public String insert()throws IOException{

return null;

}

}

/**

* @ClassName: IEnterpriseService

* @Description: TODO(企業介面)

* @author: 阮啟偉

* @company: 上海勢航網路科技有限公司

* @date 2017年7月6日 下午2:09:30

*/

public interface IEnterpriseService {

  

   /**

* @Title: insert

* @Description: TODO(添加企業方法)

* @param @throws Exception    設定檔案

* @return void    傳回型別

* @author: 阮啟偉

* @date 2017年7月6日 下午3:31:47

* @throws

*/

public void insert ()throws Exception;

}

/**

 * @ClassName: EnterpriseServiceImpl

 * @Description: TODO(企業邏輯實作類別)

 * @author: 阮啟偉

 * @company: 上海勢航網路科技有限公司

 * @date 2017年7月6日 下午2:09:56

 */

@Service("iEnterpriseService")

public class EnterpriseServiceImpl implements IEnterpriseService {

/**

* @Title: insert

* @Description: TODO(添加企業的實作類別)

* @see com.cvnavi.enterprise.service.IEnterpriseService#insert()

*/

@Override

public void insert() throws Exception {

}

}

注釋模板：  

使用方法：1、修改模板中的作者名；

2、Preferences->Java->Code Style->Code Templates->Comments->Import。

2、SQL代碼

A、SELECT、FROM、WHERE、GROUP BY、ORDER BY、子查詢等語句必須新起一行。

B、處理多表關聯的時候一定要根據實際邏輯選擇關聯方式，不能一味地使用LEFT JOIN。

C、無需關聯的表一定要刪除

D、每個寫SQL的人都必須學會通過工具查看SQL語句執行計畫，從而進行效能最佳化。特別是在操作資料量比較大的表時。

3、注意事項

1、代碼簡單易懂、富有邏輯。關鍵代碼、邏輯複雜部分必須添加詳細注釋。

2、無效代碼必須刪除。

二、代碼格式化

1、行寬設定

1.Java代碼

Preferences->Java->Code Style->Formatter->Edit ->Line Wrapping->Maximum line width:預設80

改成160就行了。

 

2.CSS代碼

Window->Preferences->Web->CSS Files->Editor->Line width:預設為72

改成160就行了。

 

3.Html代碼

Window->Preferences->Web->HTML Files->Editor->Line width:預設為72

改成160就行了。

 

4.JSP代碼

Window->Preferences->Web->JSP Files->Editor-> See ‘Editor‘ for JSP with HTML econtent->Line width:預設為72

改成160就行了。

5、XML代碼

Window->Preferences->XML --> XML Files -->  Editor->Line width:預設為80

改成160就行了。

2、快速格式化

Eclipse提供了自動格式化原始碼和管理import語句的功能（並移除未使用的語句）。你可以使用下面的快速鍵來使用這些功能。

Ctrl + Shift + F – 格式化原始碼。

Ctrl + Shift + O – 管理import語句並移除未使用的語句。

注意以上兩組快速鍵跟搜狗IME快速鍵衝突，必須去搜狗IME設定中的按鍵中把搜狗的快速鍵禁掉。

另外，你也可以設定在檔案儲存時自動排版（此方法僅限於Java代碼），設定方法如下：

Window -> Preferences -> Java -> Editor -> Save Actions->選中 Perform the selected actions on save->選中 Format source code和 organize imports。

3、SQL格式化

由於Eclipse本身在XML檔案中不支援SQL語句的合理格式化，建議大家講SQL語句在Toad for DB2(青蛙)等SQL編輯工具中格式化後粘貼到XML檔案中。同時注意，SQL語句中該加空格的時候必須加空格，併合理添加分行符號。

三、檢查標準

大家在提交代碼之前必須合理格式化自己的代碼，使代碼美觀、易讀。如發現不符合規範的代碼，則需退回、重新修改提交。

本文出自 “8429745” 部落格，請務必保留此出處http://8439745.blog.51cto.com/8429745/1947515

JAVA注釋規範