- 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
- 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
- 类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名)DO / BO / DTO / VO等。
- 方法名、参数名、成员变量、局部变量都不要使用符号,更不要有中文,都统一使用lowerCamelCase风格,必须遵从驼峰形式。
如: localValue / getHttpMessage() / inputUserId
- 大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:
- 左大括号前不换行。
- 左大括号后换行。
- 右大括号前换行。
- 右大括号后还有else等代码则不换行;表示终止右大括号后必须换行。
- 左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空格。
- 任何运算符左右必须加一个空格,包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。
- 缩进采用4个空格,禁止使用tab字符,使用tab应将tab设置为4个空格。
- 类、类属性、类方法的注释必须使用Javadoc规范,使用/*内容/格式,不得使用//xxx方式。
- 所有的类都必须添加创建者信息。
- 方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/ */注释,注意与代码对齐。