A.5　运行Checkstyle

Checkstyle 是一个命令行工具，可用于判断源代码是否遵循了指定的风格规则，还能检查出常见的编程错误，如类和方法设计中存在的问题。

要下载最新版 Checkstyle，可从 http://checkstyle.sourceforge.net/ 中下载相应的 JAR 文件。要运行 Checkstyle，可将这个 JAR 文件移到（或复制到）程序所在的目录，再打开一个终端窗口、切换到该目录并执行下面的命令：

  1. java -jar checkstyle-*-all.jar -c /google_checks.xml *.java

其中的 * 是通配符（wildcard），分别指的是当前目录中的任何 Checkstyle 版本和所有 Java 源代码文件。该命令的输出指出了发现的每个问题所在的文件和行号；例如，下面的输出指的是文件 Hello.java 中始于第 93 行、第 5 列的一个方法：

  1. Hello.java:93:5: Missing a Javadoc comment

文件 /google_checks.xml 位于下载的 JAR 文件中，其中包含 Google 的大部分风格规则。你可以使用 /sun_checks.xml 或提供自己的配置文件。更详细的信息请参阅 Checkstyle 网站。

只要经常用 Checkstyle 来检查编写的源代码，随着时间的推移，你很可能就会养成良好的风格习惯。然而，自动风格检查器的功能也存在局限。具体地说，对于注释的质量、变量名是否有意义以及算法的结构等，它们无法作出评估。

良好的注释能够让经验丰富的程序员更轻松地找出代码中的错误；好的变量名指出了程序的意图以及数据是如何组织的；而优秀的程序既高效又正确无误。