代码规范的优点

1.提高代码可读性：遵循统一的代码风格，可以使代码更易于阅读、理解和维护，从而提高代码的可读性和可维护性。

2.降低代码出错率：代码规范可以帮助开发人员避免一些常见的编程错误，从而减少代码的错误率。

3.提高团队协作性： 统一了代码规范，有利于不同的开发人员之间的交流与协作。也让整个团队得到提升。

1.命名方式

  • 命名语义化，能够达到顾名思义
  • 使用完整单词，切忌自行缩短单词。

常见的命名规范 

类的命名 （单词首字母大写）　　 例如： User

方法的命名 （首字母小写，字母开头大写） 例如：getUserInfo

常量的命名 （全部大写 ，常加下划线） 例如：MAX_VALUE

2.简洁注释

  • 能知道是做干什么的，清晰明了干净
  • 注释尽可能使用“//”；对于所有的javadoc的注释则使用“/** /”；而临时对代码块进行注释尽量使用“/ */”。
  • （2）所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。
  • （3）每个方法必须添加文档注释（类的main()方法除外）。
  • （4）每个属性必须添加注释。
  • （5）代码中至少包含15%的注释。
  • （6）注释使用中文。
     

3.一行代码长度

  • 保证自己一行代码自己能看完，看不完就下一行。
  • 方便别人看你代码的时候不用看完这行，不知道看到哪行了。

4.删除多余无用的代码块

5.Java文件名规范

  • 一个Java源文件只能储存一个Java类
  • 文件名和Java类的类名相同。

6. 声明规范

  • 不要将不同的类型变量放在同一行。
  • 只在代码开始声明变量，所有的变量必须在声明时初始化。
  • 避免声明的变量覆盖上一层的变量
  • 方法与方法以空行隔开

7.语句规范 

  • if语句要用{}大括号括起来
  • return语句，返回值不能用（）