Skip to content

Latest commit

 

History

History
67 lines (34 loc) · 2.5 KB

codestyle.md

File metadata and controls

67 lines (34 loc) · 2.5 KB

代码风格

来自阿里巴巴Java代码规范

阿里巴巴代码规范


  • 缩进

    **【强制】**4个空格,不用tab

  • 变量命名

    1.**【强制】**代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

    2.**【强制】**代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

    3.**【强制】**成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。

  • 每行最多字符数

    **【强制】**单行字符数限制不超过 120个,超出需要换行,换行时遵循如下原则: 第二行相对第一行缩进 4个空格,从第三行开始,不再继续缩进,参考示例。 运算符与下文一起换行。 方法调用的点符号与下文一起换行。 在多个参数超长,逗号后进行换行。

  • 函数最大行数

    **【强制】**函数最大80行

  • 函数、类命名

    **【强制】**类名使用UpperCamelCase风格,必须遵从驼峰形式,但以下情形例外:(领域模型的相关命名)DO / BO / DTO / VO等。

    **【强制】**函数名都统一使用lowerCamelCase风格,必须遵从驼峰形式。

  • 常量

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

  • 空行规则

    **【推荐】**方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

  • 注释规则

    1.**【强制】**类、类属性、类方法的注释必须使用Javadoc规范,使用/*内容/格式,不得使用//xxx方式。

    2.**【强制】**方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/ */注释,注意与代码对齐。

    3.与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

    4.好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。

  • 操作符前后空格

    **【强制】**任何运算符左右必须加一个空格。

  • 其他规则

    **【强制】**if/for/while/switch/do等保留字与左右括号之间都必须加空格。