HIT_SC：实验回顾 - Lab5的CheckStyle

一.修改技巧

我使用的是Google作为代码的规范的格式进行要求，确认规范后，每个文件都出现了问题提示，几乎所有位置都大片飘黄，但是在网上查阅了Google规范要求，终于花费半天时间将所有不合规范的代码改正。

1.单行代码过长

在实验中我写了不少一屏装不下的代码，选择合适的位置进行拆分。如下例，可见代码长度均匀，美观的多。

2.禁止使用tab键

Google要求，必须使用两个空格代替tab键作为行前缩进。可以使用一个快捷键(control-F)进行一键选择替换。
遵循这种代码规范，也很容易理解，Java是一个多层缩进的代码，当出现大量循环时，tab键会使代码长度变得惊人，如修改后下代码中出现的循环：

3.Javadoc的书写规范

要求每个方法都有Javadoc，且每个参数要有解释而不是简单的罗列。这对于我来说不难做到，因为实验3中已全部写完整了，只是忽略了一个小的细节，就是Javadoc的描述的最后必须有结束的符号。

4.import 库文件规则

首先不允许使用通配符(*)来导入多个类文件，即不能出现如下情况：

如果使用了相应的类，应该仅仅导入所需要的类文件，比如我使用了assertEquals以及assertNull函数，那么

另外导入的文件需要按字母表顺序严格排序。

5.驼峰式命名法

Google公司对所有变量的命名采用一定规格的正则表达式进行检查。我在写代码的时候忽略了变量命名的细节使用了驼峰和下划线两种方法结合的策略。现在一一改正，统一命名规则的代码可读性更高。

6.some details

比如运算符前后需要空格，if后紧跟空格等等。根据标黄处的提示可以很容易的进行修改。

小结： 这部分需要看起来bug多多，但是改起来却非常顺手。并不需要太动脑。但是我们需要思考的是，如何在以后避免类似的修改，而让eclipse自动帮我们生成符合规范的代码呢？

二.eclipse生成符合规范的代码

https://github.com/google/styleguide

在以上网址可以下载Google 官方提供的 eclipse-Java-google-style.xml

导入(如上图)：Eclipse->window->preferences->Java->Code Style->Formatter->Import 选择eclipse-java-google-style.xml文件。