CheckStyle安装、使用、配置.docx

PAGE \* MERGEFORMAT 9 CheckStyle说明文档 目录 TOC \o 1-4 \h \z \u HYPERLINK \l _Toc268788370 CheckStyle安装使用 PAGEREF _Toc268788370 \h 1 HYPERLINK \l _Toc268788371 1 安装 PAGEREF _Toc268788371 \h 1 HYPERLINK \l _Toc268788372 2 使用 PAGEREF _Toc268788372 \h 1 HYPERLINK \l _Toc268788373 2.1 勾选了“Use simple configuration” PAGEREF _Toc268788373 \h 2 HYPERLINK \l _Toc268788374 2.2 没有勾选“Use simple configuration” PAGEREF _Toc268788374 \h 2 HYPERLINK \l _Toc268788375 2.3 Exclude from checking PAGEREF _Toc268788375 \h 2 HYPERLINK \l _Toc268788376 2.4 Local Check Configuration PAGEREF _Toc268788376 \h 3 HYPERLINK \l _Toc268788377 3 代码规范配置文件 PAGEREF _Toc268788377 \h 4 HYPERLINK \l _Toc268788378 3.1 配置代码规范 PAGEREF _Toc268788378 \h 4 HYPERLINK \l _Toc268788379 3.1.1 新建规范文件 PAGEREF _Toc268788379 \h 4 HYPERLINK \l _Toc268788380 3.1.2 代码规范配置选项 PAGEREF _Toc268788380 \h 5 HYPERLINK \l _Toc268788381 3.2 Module配置 PAGEREF _Toc268788381 \h 6 HYPERLINK \l _Toc268788382 3.2.1 Annotations PAGEREF _Toc268788382 \h 6 HYPERLINK \l _Toc268788383 3.2.2 BlockChecks PAGEREF _Toc268788383 \h 8 HYPERLINK \l _Toc268788384 3.2.3 Class Design PAGEREF _Toc268788384 \h 10 HYPERLINK \l _Toc268788385 3.2.4 Coding PAGEREF _Toc268788385 \h 12 HYPERLINK \l _Toc268788386 3.2.5 Duplicate Code PAGEREF _Toc268788386 \h 24 HYPERLINK \l _Toc268788387 3.2.6 Headers PAGEREF _Toc268788387 \h 24 HYPERLINK \l _Toc268788388 3.2.7 Imports PAGEREF _Toc268788388 \h 25 HYPERLINK \l _Toc268788389 3.2.8 Javadoc Comments PAGEREF _Toc268788389 \h 29 HYPERLINK \l _Toc268788390 3.2.9 Metrics PAGEREF _Toc268788390 \h 32 HYPERLINK \l _Toc268788391 3.2.10 Miscellaneous PAGEREF _Toc268788391 \h 34 HYPERLINK \l _Toc268788392 3.2.11 Modifiers PAGEREF _Toc268788392 \h 39 HYPERLINK \l _Toc268788393 3.2.12 Naming Conventions PAGEREF _Toc268788393 \h 39 HYPERLINK \l _Toc268788394 3.2.13 Regexp PAGEREF _Toc268788394 \h 41 HYPERLINK \l _Toc268788395 3.2.14 Size Violations PAGEREF _Toc268788395 \h 42