java-命名规范整理.docx

Java 命名规范详解 Java 命名规范是指在 Java 编程语言中为变量、类、方法、包等命名的规则和约定。遵守良好的命名规范可以提高代码的可读性、易维护性和协作性。 包命名规范： * 包名全部小写 * 针对不同的项目类型，细分为个体项目、个人项目、私有项目、团队项目、公司项目等 * 包名的格式为“前缀.项目名.模块名.……” 例如： * 个体项目：indi.发起者名.项目名.模块名.…… * 个人项目：pers.个人名.项目名.模块名.…… * 私有项目：priv.个人名.项目名.模块名.…… * 团队项目：team.团队名.项目名.模块名.…… * 公司项目：com.公司名.项目名.模块名.…… 类命名规范： * 采用帕斯卡命名法，类名以大写字母开头 * 如果类名称由多个单词组成，则每个单词的首字母均应为大写 例如：TestDemo、DOMDemo POJO 类命名规范： * 具有含义的名字 * 如果有多个单词，每个单词头字母大写 例如：StudentInfo 接口类命名规范： * 业务逻辑接口实现类的命名以 POJO 名称来制定 * 以大写字母"I"开头 例如：IStudentInfo 接口实现类命名规范： * 业务逻辑接口实现类的命名以 POJO 名称来制定 * 将实现的接口名称的首字母"I"去掉，以"Impl"作为结尾 例如：StudentInfoImpl 方法命名规范： * 首字母小写，其他单词首字母大写 * 使用完整的描述来准确描述方法名 例如：getName()、getNameByIdFromDB() 方法参数命名规范： * 使用有特定意义的词定义方法参数 * 如果参数需要区分和局部变量不重名的情况，则可以考虑加上 Param 例如：userNameParam 变量命名规范： * 采用驼峰命名 * 变量名要尽量简短，并且可以顾名思义 例如：userName、studentAge 静态变量命名规范： * 全部大写，单词间用"_"连接 例如：static int THREAD_FL 遵守良好的命名规范可以提高代码的可读性、易维护性和协作性。但是，命名规范并不是一成不变的，应根据实际情况进行调整和修改。