JAVA註釋規範

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

一、Java代碼

1、註釋

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

/**

*@ClassName:Enterprise

*@Description:TODO(企業交互)

*@author:阮啟偉

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

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

*/

publicclassEnterprise{

@Autowired

privateIEnterpriseServiceiEnterpriseService;

/**

*@Title:insert

*@Description:TODO(企業添加)

*@param@return

*@param@throwsIOException設定文件

*@returnString返回類型

*@author:阮啟偉

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

*@throws

*/

publicStringinsertthrowsIOException{

returnnull;

}

}

/**

*@ClassName:IEnterpriseService

*@Description:TODO(企業介面)

*@author:阮啟偉

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

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

*/

publicinterfaceIEnterpriseService{

/**

*@Title:insert

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

*@param@throwsException設定文件

*@returnvoid返回類型

*@author:阮啟偉

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

*@throws

*/

publicvoidinsertthrowsException;

}

/**

*@ClassName:EnterpriseServiceImpl

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

*@author:阮啟偉

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

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

*/

@Service("iEnterpriseService")

publicclassEnterpriseServiceImplimplementsIEnterpriseService{

/**

*@Title:insert

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

*@seecom.cvnavi.enterprise.service.IEnterpriseService#insert

*/

@Override

publicvoidinsertthrowsException{

}

}

註釋模板：

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

2、Preferences->Java->CodeStyle->CodeTemplates->Comments->Import。

2、SQL代碼

A、SELECT、FROM、WHERE、GROUPBY、ORDERBY、子查詢等語句必須新起一行。

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

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

D、每個寫SQL的人都必須學會通過工具查看SQL語句執行計劃，從而進行性能優化。特別是在操作數據量比較大的表時。

3、注意事項

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

2、 無效代碼必須刪除。

二、代碼格式化

1、行寬設置

1.Java代碼

Preferences->Java->CodeStyle->Formatter->Edit->LineWrapping->Maximumlinewidth:默認80

改成160就行了。

2.CSS代碼

Window->Preferences->Web->CSSFiles->Editor->Linewidth:默認為72

改成160就行了。

3.Html代碼

Window->Preferences->Web->HTMLFiles->Editor->Linewidth:默認為72

改成160就行了。

4.JSP代碼

Window->Preferences->Web->JSPFiles->Editor->See'Editor'forJSPwithHTMLecontent->Linewidth:默認為72

改成160就行了。

5、XML代碼

Window->Preferences->XML-->XMLFiles-->Editor->Linewidth:默認為80

改成160就行了。

2、快速格式化

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

Ctrl+Shift+F–格式化源代碼。

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

注意以上兩組快捷鍵跟搜狗輸入法快捷鍵衝突，必須去搜狗輸入法設置中的按鍵中把搜狗的快捷鍵禁掉。

另外，你也可以設置在文件保存時自動排版（此方法僅限於Java代碼），設置方法如下：

Window->Preferences->Java->Editor->SaveActions->選中Performtheselectedactionsonsave->選中Formatsourcecode和organizeimports。

3、SQL格式化

由於Eclipse本身在XML文件中不支持SQL語句的合理格式化，建議大家講SQL語句在ToadforDB2(青蛙)等SQL編輯工具中格式化后粘貼到XML文件中。同時注意，SQL語句中該加空格的時候必須加空格，併合理添加換行符。

三、檢查標準

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