java命名规范

一，java文件命名规范

　　1.包名（package）

　　　　命名必须全部使用英文小写字母，禁止使用“下划线”等字符。（除常量外，Java命名习惯中均不推荐使用下划线等字符）

　　　　项目包命名规则：<域名反转>.<团队名>.<项目名>。相关项目可使用<域名反转>.<团队名>.<父项目名>.<子项目名>的命名法则。

　　2.Class/Object、Interface

　　　　类和接口使用大驼峰命名法

　　　　抽象类使用“Abstract”做为类命名的开头

　　　　Exception类命名使用“Exception”做为类命名的结尾

　　　　Test类使用“Test”做为类命名的结尾

 

　　　　在面向接口编程中，接口的实现类的命名规则为：<接口名>+"Impl"。禁止使用匈牙利命名法。

　　　　示例（正确）：

接口	实现类
HandsomeProvider	HandsomeProviderImpl

 

 

 

 

匈牙利命名法（不推荐）：

接口	实现类
IHandsomeProvider	HandsomeProvider

 

 

 

　　3.Method/Function

 

　　　　方法的命名使用驼峰法，一般使用动词或动词+名词组合。

 

　　　　设置/获取某个值的方法，命名为setV/getV

 

　　　　返回长度的方法，命名为length

 

　　　　判断布尔值的方法，命名为isV

 

　　　　将对象转换为某个特定类型的方法应该命名为toT

　　4.变量的命名

　　　　第一个单词的首字母小写，其后单词的首字母大写 例如：maxValue。
　　　　变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。
　　　　pojo中的布尔变量，都不要加is(数据库中的布尔字段全都要加 is_ 前缀)。

　　5.常量/枚举值的命名规范

　　　　常量名/枚举值应该都使用大写字母，下划线分割单词。
　　　　例如：MAX_VALUE

二，数据库命名规范

　　表名和字段名字必须用小写字母或数字，数字不可开头，两个下划线中间不能只有数字。
　　库名与应用名尽量一致。
　　表名：业务名称_表的作用(单数形式)。
　　主键索引：pk_字段名。
　　唯一索引：uk_字段名。
　　普通索引：idx_字段名。
　　表示是否字段：is_xxxx unsigned tinyint(1.表示是，0.表示否)。
　　触发器：trg_表名_[ insert | update | delete ]
　　视图：viw_相关表名1_相关表名2_...
　　数据库禁止用存储过程。

三，版本工具提交信息规范

　　第1行：提交修改内容的摘要(少于25个汉字，或英文大写字母开始，不加句号，使用祈使句)。
　　第2行：空行
　　第3行及以后：修改的理由(36个汉字左右换行，正文解释是什么和为什么，而不是如何做)。

原文地址：https://www.cnblogs.com/caixueliang/p/7469638.html，https://www.cnblogs.com/niceboat/p/6180625.html