JAVA注释规范（java注释格式范例）

势航车联网平台（CVNAVI）开发平台方面代码规范

一、Java代码

1、注释

类头、方法头必须添加注释，例如：

/**

*@ClassName:Enterprise

*@Deion:TODO(企业交互)

*@author:阮启伟

*@company:上海势航网络科技有限公司

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

*/

publicclassEnterprise{

@Autowired

privateIEnterpriseServiceiEnterpriseService;

/**

*@Title:insert

*@Deion:TODO(企业添加)

*@param@return

*@param@throwsIOException设定文件

*@returnString返回类型

*@author:阮启伟

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

*@throws

*/

publicStringinsert()throwsIOException{

returnnull;

}

}

/**

*@ClassName:IEnterpriseService

*@Deion:TODO(企业接口)

*@author:阮启伟

*@company:上海势航网络科技有限公司

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

*/

publicinterfaceIEnterpriseService{

/**

*@Title:insert

*@Deion:TODO(添加企业方法)

*@param@throwsException设定文件

*@returnvoid返回类型

*@author:阮启伟

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

*@throws

*/

publicvoidinsert()throwsException;

}

/**

*@ClassName:EnterpriseServiceImpl

*@Deion:TODO(企业逻辑实现类)

*@author:阮启伟

*@company:上海势航网络科技有限公司

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

*/

@Service("iEnterpriseService")

publicclassEnterpriseServiceImplimplementsIEnterpriseService{

/**

*@Title:insert

*@Deion:TODO(添加企业的实现类)

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

*/

@Override

publicvoidinsert()throwsException{

}

}

注释模板：

使用方法：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语句中该加空格的时候必须加空格，并合理添加换行符。

三、检查标准

大家在提交代码之前必须合理格式化自己的代码，使代码美观、易读。如发现不符合规范的代码，则需退回、重新修改提交。