一、命名规范
1.项目:名全部小写
2.包名:全部小写(多个文件夹中间用“.”隔开,一般以com+公司名称+项目名称+当前功能名称)
3.类名:首字母大写,如果由多个单词组成,每个单词的首字母大写
4.变量名、方法名:首字母小写,如果有多个单词组成,每个单词的首字母大写
5.常量名:全部大写(每个单词间用“_”隔开)
6.所有的命名规则都要遵循以下几点:
a.名称只能由字母、数字、下划线、$符号组成
b.不能以数字开头
c.名称不能使用java的关键字
d.坚决不允许出现中文以及拼音命名
二、注释规范
1.类前必须加上注释类
例:(让看代码的人一眼就能看出实现的功能)
/**
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00 版本
*/
2.属性的注释
每个属性前必须加上注释
例:
/**属性信息**/
private string str=null;
3.方法的注释
在每个方法前必须加上注释
例:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
4.构造方法的注释
每个构造方法前必须加上注释
例:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
5.方法内部的注释
方法内部分单行注释和多行注释,根据实际情况添加
例:
//当前日期
过去的再好也是回忆,将来好的也是空想,只有珍惜现在才有美好的未来。