(续)JAVA应用技术之编码规范(Eclipse checkstyle plugin)

本文介绍如何利用Eclipse Checkstyle插件自动检查并格式化代码,通过自定义规则确保代码质量,提高开发效率。通过安装插件、配置规则、应用规则到项目中,实现代码自动校验,解决常见的编码规范问题。
1.安装Eclipse Check插件(略)
(可查看之前杰哥写的安装方法)

2.书写自已的checkstyle.xml文件
如 my_test_check.xml文件
  1. <!DOCTYPE module PUBLIC
  2. "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
  3. "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
  4. <module name="Checker">
  5. <module name="TreeWalker">
  6. <module name="ParameterAssignment">
  7. <property name="severity" value="warning"/>
  8. </module>

  9. <module name="ModifierOrder">
  10. <property name="severity" value="info"/>
  11. </module>

  12. <module name="MethodName">
  13. <property name="severity" value="warning"/>
  14. </module>

  15. <module name="EmptyStatement">
  16. <property name="severity" value="info"/>
  17. </module>

  18. <module name="InnerAssignment">
  19. <property name="tokens" value="ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN"/>
  20. </module>

  21. <module name="DoubleCheckedLocking">
  22. <property name="severity" value="warning"/>
  23. </module>

  24. <module name="UnusedImports">
  25. <property name="severity" value="info"/>
  26. </module>

  27. <module name="StringLiteralEquality">
  28. <property name="severity" value="warning"/>
  29. </module>


  30. <module name="RedundantModifier">
  31. <property name="severity" value="info"/>
  32. </module>

  33. <module name="RedundantThrows">
  34. <property name="severity" value="info"/>
  35. </module>

  36. <module name="LineLength">
  37. <property name="max" value="120" />
  38. </module>


  39. <module name="MethodLength">
  40. <property name="tokens" value="METHOD_DEF" />
  41. <property name="max" value="60" />
  42. </module>

  43. <module name="MagicNumber">
  44. <property name="tokens" value="NUM_DOUBLE, NUM_INT" />
  45. </module>

  46. </module>

  47. </module>
复制代码
3.应用my_test_check.xml
点击eclipse菜单下面的windows下面的preferences,先择checkstyle项,如下所示:

Snap58.jpg


然后点击Properties按钮,如下所示:


Snap59.jpg


这样我们就引入了我刚才所定义的规则了。



4. 在项目中使用该规则


4.1 使用 sun公司的规则


(略)


因为该规则过于苛刻,在我们进行的项目中,不太适合,因此要根据我们需要自定义规则。



4.2 使用我刚才所定义的规则


右键点击项目选中properties,选中checkstyle,如下所示:

Snap60.jpg



点击OK按钮即可应用该规则.


我们在该项目中看到,如下所示:


Snap62.jpg




出现如下问题:


10000' is a magic number. 这个即是我刚才定义的规则



<module name="MagicNumber">
<property name="tokens" value="NUM_DOUBLE, NUM_INT" />
</module>

与之相联系。

5.总结:

由于项目对代码格式有严格要求,而又不能人工一一去检查代码书写是否符合格式要求,所以引用了一个eclipseCheckstyle插件来检查代码的格式,这样当你书写完一行代码之后,eclipseCheckstyle插件会立即检查你的代码是否符合所设定的格式。



链接地址:


http://yuyujulin.iteye.com/blog/1328879


http://www.blogjava.net/vip01/archive/2007/01/30/96708.html


http://i.1224.blog.163.com/blog/static/135712239200911280759975/?fromdm&fromSearch&isFromSearchEngine=yes


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值