1、注释规范:
1.Javadoc注释:通常情况下我们会在类,以及方法的上方使用到Javadoc注释来描述类以及方法的作用。
如图:
2.单行代码注释:通常情况下单行注释会在你需要提示的代码上方,并于代码并列,注释与注释内容以一个空格分开。
如图:
3.多行代码注释:通常情况下多行注释也会会在你需要提示的代码块上方,并于代码并列,开始与结束会用换行来提高注释的可读性。
如图:
2、类方法变量命名规范
- 大部分情况下代码开发中都会采用驼峰命名方式,驼峰命名格式如下
1.类名:每个单词之间第一个字符为大写。
2.方法名:第一个单词第一个字符为小写,后面的单词以第一个字符为大写。
3.普通变量名:同方法命名格式一样。
4.常量命名,常量命名是所有字符为大写单词之间用下划线隔开。
如图:
3、逻辑代码编写注意事项
- equals使用,把能确认的值作为前者,而不是把不能正确值得变量作为前者。
例如
String str = null;
// 这样变量如果为空程序并不会有上面影响
if("你好".equals(str))
// 如果把变量作为前者就有可能导致程序报空指针异常
if(str.equals("你好"))
- 接口当中的抽象方法不需要添加public static abstract 等关键字。
- 方法参数过长可以进行有序的换行。
如图:
- 逻辑代码中可以适当按功能模块以换行区分。
如图:
- mapping映射文件中同上也可以使用恰当的回车进行分割,这样也会让后期维护人员一目了然
如图本文开发规范只是个人经验建议,后续持续更新。