你的位置:首页 > Java教程

[Java教程]如何很好的Review自己的代码


  写这篇博文的原因是因为自己写的代码经常会因为返工,delay项目的交付日期。总结了一下引起项目delay的原因,大概有如下几点:

  1. 在没有完全深熟悉需求交互细节的情况下;诸如根据不同渠道设置不同的订单状态变更--超时提醒和订单取消功能
  2. 在没有想清楚自己代码如何实现业务逻辑的情况下;诸如对骑手排班--明天到当前周期结尾的排班及排班详情展示
  3. 是否对业务逻辑有完整的测试用例;商家详情权限功能和可逆向加密算法的测试用例

往往第一步和第二步是同时出现的,第二步的出现也在很大程度上源自于对需求交互细节的理解不到位,所以我们在开发中养成的习惯应该是这样的:

  1. 认真看需求分析,最好能复述出需求细节;构思自己代码如何实现该逻辑。
  2. 多沟通,与产品经理与前端工程师、测试工程师沟通清楚需求交互细节。

当然上面总结的还都是理论,我们在开发中应该以此为指导,慢慢养成良好的开发习惯。注解的使用。当跟别人一起开发某个功能,很可能由于方法取名的问题,写了重复的方法,在代码Review的时候,可以在方法上添加@Deprecated的注解,表示该方法是过时的,当有应用调用该方法的时候,会报错。 

 1 <!-- 注解的使用示例 --> 2  3 public class AnnotationTest extends Test 4 {   5  6   @SuppressWarnings("deprecation") 7   public static void main(String []args) 8    {   9    10       <!--这句话是程序命令。执行的操作是当程序结束的时候运行垃圾回收-->  11      System.runFinalizersOnExit(true) ;12      sayHello();13      AnnotationTest t=new AnnotationTest() ;14      t.show() ;15    }16 17   <!--在方法上使用该方法,在使用该方法处会报错-->18    @Deprecated   19   public static void sayHello()20    {21      System.out.println("hello ,world!");22    }23 24    @Override25   public void show()26    {27      System.out.println("super class");28    }29 30 }31 32 33 public class Test {34    @Deprecated35   public void show()36    {37      System.out.println("super class");38    }39 }

 

 上面是使用@Deprecated、@SupressWarning、@Overrider三个注解的示例,注解会被javac所识别,解析为注解类,编译器会根据不同的注解,编译出不同的结果,@Deprecated注解表示过时的方法,在使用低版本的JDK中方法的时候会出现;@SurpressWarning("deprecation")注解是抑制过时API的警告 ,这个可以放在调用过时的API的方法外部或者调用方法之前,那么在编译的时候javac遇到这个标识,即使知道API过时那么也不会输出过时API的提示。 

 1 <!--使用频率80%--> 2 Alt + '/' 代码提示 3 sysout + Alt + '/' 自动补全“System.out.println();” 4 public void AnnotationTest 双击类名Annotation,点击Run As->Java Application,即可以运行该测试类 5 Ctrl + '/' 为光标所在的行添加注释"//",不需要事先选中该行,取消注释也是Ctrl + '/' 6 Ctrl + Shift + '/' 添加注释"/* */",需要事先选中该行,取消注释使用Ctrl + Shift + '\' 7 Ctrl + Shift + 'C' 添加多行注释"//",取消注释同样使用Ctrl + Shift + 'C' 8 Ctrl + 'D' 删除当前行 9 Ctrl + 'M' 最大化和最小化当前光标所在的IDE窗口10 Ctrl + 'L' 跳转到指定的所输入的行标数11 Ctrl + Shift + 'T' 查找工作空间内的指定类名12 Ctrl + Shift + 'O' 慎用,因为有时候import的包不是你所需要的包13 Alt + '<-' 和 Alt + '->' 跟踪光标的上一个位置和下一个位置14 15 Alt + Shift + 'J' 添加注释,该注释方便Eclipse生成API文档,

附:

  1. Eclipse安装眼睛保护色主题,可以直接打开 Help -> Eclipse Marketplace 搜索Eclipse Color Theme来进行安装:安装完之后就可以在(Window->Preferences->General->Apperance->Color Theme)中找到颜色主题插件的设置界面了,在这里可以根据自己的喜好选择自己喜欢的主题了。
  2. Eclipse中设置注释标签@User的三种方式:第一种,在Eclipse安装目录中的eclipse.ini中添加一句 -vmargs -Duser.name=Sun, Wu-Kong;第二种,通过菜单 Window->Preference -> Java -> Code Style -> Code Templates 在右侧选择Comments,将其中的Types项,然后选右边的"Edit",进入编辑模式,将 @author ${user} 中的${user}改成你自己的名字即可;第三种,计算机-->管理-->本地用户和组-->用户,使用管理员账户登陆 可以任意修改用户名 ,然后重启电脑。 
  3. Eclipse中的项目如何生成javadoc文档,项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步,在Javadoc Generation对话框中有两个地方要注意的:javadoc command:应该选择本机安装jdk路径中的\jdk1.8.0_31\bin\javadoc.exe,destination:为生成文档的保存路径,可自由选择,按finish(完成)提交即可开始生成文档。接着可以看到Console控制台的输出。
  4. 更多快捷方式参考:http://jingyan.baidu.com/article/c275f6bac8e43ae33d756716.html