Java 基本规范

1. 类

• 同一个源文件中可以定义多个类，但是只能有一个公开类
• public 修饰的类称为公开类，类名必须与文件名称完全相同，包括大小写
• 编译后，每个类都会生成独立的 .class 文件
• 一个类中，只能有一个主方法，每个类都可以有自己的主方法

2. 包（package）

• 作用：类似于文件夹，用于管理字节码（.class）文件
• 语法：package 包名;
• 位置：源文件的第一行
• 采用域名倒置的命名规则

3. 编码规约

3.1 书写格式

• 层级之间必须缩进
• 一行只写一句代码

3.2 注释

单行注释 // 单行注释

多行注释

/* 
 多行注释
 多行注释
*/

文档注释 （生成外部文档：javadoc -d . xxx.java）

/**
 * 文档注释
 */

3.3 命名规范

• 语法规定
  • 由 字母、数字、下划线，$ 组成，但不能以数字开头
  • 不能与关键字、保留字重名
• 约定俗成
  • 类名由一个或多个单词组成，每个单词首字母大写
  • 包名全小写，只可以使用特殊字符 .
  • 常量全大写，多个单词用 _ 连接
  • 函数名、变量名由一个或多个单词组成，首字母小写，拼接词首字母大写

4. pojo 类命名

• java的几种对象(PO,VO,DAO,BO,POJO，DTO)解释

5. 业务逻辑

构造方法禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中
Map<String/备注/, List<String>> map = new HashMap<>();