代码格式化快捷键

• IDEA: Ctrl + Alt + l
• VSCode: Shift + Alt + F

Common

空格

• if / for / while / switch / do 条件语句和循环语句关键字与括号之间后均有空格
• else 前后有空格
• 循环里内; 后恒有空格
• 方法参数在定义和传入时, 多个参数逗号后边必须加空格
• 任何二目、三目运算符的左右两边都需要加一个空格
• 左大括号前总是有空格
• 分号前不加空格
• 行尾不要留空格
• 圆括号内部不紧邻空格

换行

• 空行越少越好, 空行不要超过 2 行
• 两个函数定义之间的空行不要超过 2 行, 函数体首尾不要留空行, 函数体中也不要随意添加空行.

缩进

• 采用 4 个空格缩进, 禁止使用 tab 字符[IDEA 设置 tab 为 4 个空格时, 请勿勾选 Use tab character]

注释

• 注释的双斜线(//)与注释内容之间有且仅有一个空格
• 类、类属性、类方法的注释必须使用 Javadoc 规范, 使用/**内容*/格式
• 方法内部单行注释, 在被注释语句上方另起一行, 使用//注释
• 方法内部多行注释, 使用/* */注释, 注意与代码对齐
• 所有的枚举类型字段必须要有注释, 说明每个数据项的用途
• 代码修改的同时,注释也要进行相应的修改, 尤其是参数、返回值、异常、核心逻辑等的修改
• 单行注释与代码在同一行的, 要将同一区域的注释对齐

命名

• 定义变量名要有含义, 可以让阅读者易于理解,避免歧义, 尽量与业务数据对应
• 杜绝完全不规范的缩写, 避免望文不知义
• 包名统一使用单数形式, 但是类名如果有复数含义,类名可以使用复数形式
• 对于缩写单词, 所有字母大小写要一致
• 实体名：大驼峰
• 枚举名：大驼峰, 并且以Enum结尾
• 变量名：小驼峰
• 布尔变量：尽量以 “is” 开头
• 方法名：采用小驼峰形式, 以动名词格式
• 事件名：尽量以”on”开头, 小驼峰形式

JS

• 枚举类型字段直接取值的, 要说明枚举类型和枚举值对应的含义, 例: jobActivity: 0, // 任务活动(0: 上线：起始工序上线)
• 对Object属性赋值时, 要将同类(包括语法和业务含义等)的放到一起

CSS

• 定义类名要以模块名为前缀