Code Style工具规范编码风格

来源:互联网 发布:基督山伯爵 知乎 编辑:程序博客网 时间:2024/05/21 22:43

      今天在Spark 的源码目录下建立一个测试文件,只是写了如下Scala 代码:

package org.apache.sparkimport org.apache.spark.internal.Loggingimport org.apache.spark.rdd.RDDobject Test extends Logging {  def main(args: Array[String]): Unit = {    logInfo("haha" + classOf[RDD[_]])  }}

      显然,代码并没有什么问题,但是会出现编译错,让把 scalastyle_config.xml 文件放入.idea目录下,放进去后仍报错。于是查了一下该文件:是个简单易用的code style检测工具,非常轻巧。有助于团队风格一致。集成在maven里用很方便。具体参考:scalastyle工具

      原来是scalastyle_config.xml文件中指定

  <check level="error" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">

      开启了文件开头Lisence检测。而我写的测试代码之前没加Lisence注释。对此又查了一下Code Style相关,这才发现代码风格可以通过代码风格工具控制,是个不错的idea。         

      之前写代码,风格都靠自己控制,大家在svn上提交的代码风格各异,很不利于协作编程,代码也比较混乱。但是有了Code Style小工具,可以产生一定的约束作用。功能重要,代码风格以及后期的可维护性也很重要。网上找了一些Code Style相关文章,如拯救Java Code Style强迫症 周宇刚 给出了一些更为广泛的论述,除了在开发者本地进行风格控制,还可以在提交代码时把好代码风格的关。使用CheckStyle检查编码规范 一文给出了主流IDE(IDEA和Eclipse)下安装CheckStyle插件的方法。


      总之,便于开发者工作的小工具也是不容忽视的。

0 0
原创粉丝点击