最近在读项目的过程中,发现好多同事的代码并不是很规范,有的包名也按照了驼峰的写法,虽说这样不是不行,但个人认为开发过程中应该遵守这些规范,现整理规范如下:
一:包名命名规范:
包名一律小写,没有下划线,第一个字母不是能数字,包命的路径为com.example.项目名称.功能名称(域名的倒写)
二:类名、接口命名规则
类和接口的名称应是一个名词,采用大小写混和的方式,如果使用拼音则应是全拼,所有单词都应紧靠在一起,其中每个单词的首字母应大写,接口名称应以大写,每个类定义要前必须加类的说明
三:方法命名规则
每个方法前必须加说明包括:参数说明、返回值说明、异常说明。如果方法名实在是太长可以对变量名缩写,但是必须添加相应的说明
四:变量命名规则
变量命名一般采用大小写混和的方式,第一个单词的首字母小写,其后单词的首字母大写,变量名一般不要用下划线或美元符号开头。变量名应简短且有意义,即能够指出其用途。除非是一次性的临时变量,应尽量避免单个字符的变量名。
五:常量命名规则
类常量和ANSI常量的命名应全部用大写,单词间用下划线隔开。