/
README.txt
40 lines (24 loc) · 1.15 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Commented package visibility check (Checkstyle plugin)
A plugin of Checkstyle (http://checkstyle.sourceforge.net/) that checks
whether package visibility is commented instead of modifier. For example,
"/* package */".
Required softwares :
* Checkstyle 5.5 or above (http://checkstyle.sourceforge.net/)
Usage :
1. Add module "CommentedPackageVisibilityCheck" as a submodule of TreeWalker to
your Checkstyle configuration.
For example :
<module name="TreeWalker">
<module name="CommentedPackageVisibilityCheck" />
</module>
2. Add JAR of this plugin to classpath to run Checkstyle.
Properties of CommentedPackageVisibilityCheck :
format : Pattern of package visibility comment.
Default is "/\* package \*/" ("/* package */").
requireLatterWhiteSpace : Controls whether to require white space after
package visibility comment.
Default is true.
NOTICE for developers :
When you run tests without Maven 3, you must need to set
the following VM arguments :
-Dtestinputs.dir=src/testinputs/com/github/mikanbako/checkstyle/commentedpackagevisibilitycheck