checkstyle安装、使用、配置

《checkstyle安装、使用、配置》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、CheckStyle说明文档目录CheckStyle安装使用11安装12使用12.1勾选了“Usesimpleconfiguration”22.2没有勾选“Usesimpleconfiguration”22.3Excludefromchecking22.4LocalCheckConfiguration33代码规范配置文件43.1配置代码规范43.1.1新建规范文件43.1.2代码规范配置选项53.2Module配置63.2.1Annotations63.2.2BlockChecks83.2.3Class

2、Design103.2.4Coding123.2.5DuplicateCode243.2.6Headers243.2.7Imports253.2.8JavadocComments293.2.9Metrics323.2.10Miscellaneous343.2.11Modifiers393.2.12NamingConventions393.2.13Regexp413.2.14SizeViolations423.2.15Whitespace453.3常见CheckStyle错误提示493.4CheckSty

3、le配置范例5149CheckStyle安装使用1安装将features和plugins分别copy到eclipse/plugins和/eclipse/features目录，重启Eclipse即完成checkstyle插件安装,依次点击windowàPreferences，如果出现Checkstyle标签，说明安装成功：安装完成CheckStyle插件后，下面就是统一Eclipse的格式化模板，要让格式化出来的代码符合Checkstyle要求，将topsec_format.xml文件导入到eclipse

4、，方法如下：WindowàPreferencesàJavaàCodeStyleàFormatterà点击import按钮即完成导入,如图:49建议：用ctrl+shift+f格式化代码。2使用右键点击要进行代码规范检查的项目，选择CheckstyleàCheckCodeWithCheckStyle,即完成代码检查：493代码规范配置文件在eclipse的windows->Preferences找到CheckStyle进行配置。可以建立新的全局代码规范文件，并设为默认规范。3.1配置代码规范3.1.1新建

5、规范文件点击“New”新建一个代码规范配置文件，如图3-1所示。图3-1新建代码规范文件示意图在弹出对话框中，首先选择文件类型，包括InternalConfiguration,ExternalConfigurationFile,RemoteConfiguration,ProjectRelativeConfiguration四种类型。InternalConfiguration：内建于eclipse的workspace中，位于workspace_dir/.metadata/.plugins/net.sf.e

6、clipsecs.core目录下，无法在项目目录中看到，文件内容可从已有的规范文件中导入，点击右下的“Import”按钮，找到相应的规范文件即可，此时是将外部分配置文件复制到workspace_dir/.metadata/.plugins/net.sf.eclipsecs.core目录下，重新命名。ExternalConfigurationFile：直接在项目中引用外部代码规范文件，并可以通过对规范进行配置来修改外部文件。适合团队协作开发。勾选“ProtectCheckStyleConfiguratio

7、nFile”防止源文件被改写。RemoteConfiguration：连接到远程代码规范文件，需要提供地址，用户名和密码。勾选“CacheConfigurationFile”来对远程文件进行缓存处理。此文件的配置不可修改，否则经过配置后会修改原规范文件，删除掉原规范文件的所有注释。ProjectRelativeConfiguration：当代码规范配置文件已经存在于workspace中的项目里时，适合于使用此选项。此处可以再确定配置类型后，直接从已有的规范文件中导入，点击“Import”按钮，找到相应的

8、文件即可。此处可以点击“AdditionalProperties”按钮自定义一些变量，方便在后面配置自定义消息时使用。内建的变量如下：${basedir}：当前工程所在的目录${project_loc}：与${basedir}相同49${workspace_loc}：当前workspace的目录${config_loc}&${samedir}：当前代码规范配置文件所在的目录当使用external,RemoteorProjectRelativ