Code Style

变量命名

  1. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束
  2. 类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名)DO / BO / DTO / VO等。
  3. 方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。
  4. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

缩进

  1. 缩进4个空格

每行最多字符数

  1. 每行最多字符数为80个字符

函数最大行数

函数的最大行数为200行

函数和类命名

  1. 函数命名使用lowerCamelCase风格,必须遵从驼峰形式
  2. 类命名使用UpperCamelCase风格,必须遵从驼峰形式

常量命名

  1. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长

空行规则

  1. 两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。

注释规则

  1. 类、类属性、类方法的注释必须使用Javadoc规范,使用/*内容/格式,不得使用//xxx方式。
  2. 所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。

操作符前后空格

  1. 操作符左右有操作数时,左右都空一格,只有一边有操作数,则操作数和操作符之间空一格
posted @ 2021-03-03 16:35  Fino-  阅读(52)  评论(0编辑  收藏  举报