Java开发项目的命名规范+命名方法+注释规范

一、命名规范

变量Variable

变量名通常以小写字母 a-z 开头。如果变量名由多个单词构成，从第二个单词开始首字母需要大写 A-Z （小驼峰命名法）。变量名中不建议使用下划线 _ 作为前缀或者单词之间的分隔符。eg：

private Long userId;
private double price;
private String teacherName;

常量Constant

常量名通常全部采用大写字母 A-Z 。如果常量名由多个单词构成，可用下划线 _ 作分隔符（蛇形命名法）。eg：

public final double PI = 3.1415926;
public static final String ANSI_RESET = "\u001B[0m";//字体颜色重置
public static final String ANSI_RED = "\u001B[31m";//红色字体

方法Method

方法名通常采用 动词+名词 的组合、以小写字母 a-z 开头。如果方法名由多个单词构成，从第二个单词开始首字母需要大写 A-Z （小驼峰命名法）。eg：

public int size(){}
public boolean isEmpty(){}
public String getUserName(){}//用get作前缀表示获取某变量
public void setUserName(){}//用set作前缀表示设置某变量
public List<User> findAllUser(){}//用find、query作前缀表示查询
public List<Order> getOrdersByUserId(Long userId){}//用by、with作为连接符表示方法需要的参数

方法名也可用 _ 作分隔符连接多个单词（蛇形命名法）。eg：

public List<Order> get_orders_by_userId(Long userId){}

类Class

类名通常是 名词 或者 名词+动词 或者 名词+形容词 、以大写字母 A-Z 开头。如果类名由多个单词构成，则每个单词首字母都需大写 A-Z （大驼峰命名法）。eg：

public class UserDaoImpl{}
public class PageBean<T>{}
public interface UserService{}//名词+动词
public abstract class AbstractAspectJAdvice{}//用Abstract、Base作前缀表示该类是抽象类

包Package

包名通常用 名词 组合而成，以小写字母 a-z 开头，并用 . 作分隔符，每个被分隔的单元都是一个名词。包名通常使用顶级域名 com、cn、net、org、edu、gov 等作前缀。eg：

package com.alibaba.druid;
package org.springframework.boot.util;
package java.io;
package java.lang;
package java.util;

项目Project

项目名通常全部采用小写字母 a-z ，并以 - 作分隔符（串式命名法）。eg：

spring-springmvc-mybatis

二、命名方法

小驼峰方法

第一个单词首字母小写 a-z、第二个单词的首字母大写 A-Z 。eg：userId 。可用在：方法名、参数名、成员变量、局部变量。

大驼峰方法

每个单字的首字母都采用大写字母 A-Z 。eg：HelloWorld 、UserDaoImpl。可用在：类名。

蛇形命名法

各个单词之间通过下划线 _ 连接。eg：get_orders_by_userId。可用在：测试方法名、常量、枚举名（常用在命名所需要的单词较多的时候）。

串式命名法

各个单词之间通过下划线 - 连接。eg：spring-springmvc-mybatis 。可用在：项目名。

三、注释规范

IDEA 中有添加注释的默认快捷方法：在类、方法的前一行输入 /** 然后回车，即可生成类、方法对应的基本注释。

给类加注释

/**
* 类的详细说明
* @author 类创建者姓名
* @Date    创建日期
* @version 1.00
*/

在 IDEA 中修改类的注释模板：File -> Settings -> Editor -> File and Code Templates -> Files。

给方法加注释

/**
* 方法的详细说明
* @param 参数1 参数1的使用说明
* @param 参数2 参数2的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

在 IDEA 中修改方法的注释模板：File -> Settings -> Editor -> Live Templates。

给属性加注释

/** 属性的提示信息 */

其他

//这是单行注释，快捷键ctrl+/
/*
	这是多行注释（文档注释），快捷键ctrl+Shift+/
*/