checkstyle eclipse plugin

CheckStyle将能够为你带来在eclipse中所能够使用的样式插件，让你能够更好地进行各项编程操作，为你提供各类样式的制作带来最佳的编程效果，轻松实现所需的各类编程功能！

官方介绍

是SourceForge下的一个项目【gè xiàng mù】，提供了一个帮🆒助JAVA开发人员遵守🕎某些编【mǒu xiē biān】码规范的工具【de gōng jù】。它能够自动化🤞代码规范检查【fàn jiǎn chá】🐎过程💢，从而使得开发人员从📈这项重🚦要【yào】，但是枯【dàn shì kū】燥的任😨务中解【wù zhōng jiě】脱出来【tuō chū lái】。

安装方法：

下载成功后，将文件解压，会有两个文件夹features和plugins，将两文件夹下的内容分别复制到myeclipse 6.0\eclipse下面的features和plugins两个文件夹下，重新启动myeclipse，在window-->preferences下面可以看到Checkstyle

方法一：

1.Eclipse中，选择【xuǎn zé】👥Help->Software Updates->Find and Install

2.选择【xuǎn zé】🌺 Search for new features to install 选择【xuǎn zé】🌺Next

3.选择【xuǎn zé】🔯 New Remote Site

4.输入更新地址

http/k/eclipsechajian/" target="_blank">eclipse插件【chā jiàn】💐

下载后，把里面【bǎ lǐ miàn】的🎑两个文件夹【jiàn jiá】plugins和【hé】🔺 features下面的🎑文件分别拷贝🚌到【dào】eclipse目录🐱下面对应的【yīng de】🎑plugins和【hé】🔺features目录🐱

2.如果你🅿就这样直接启【zhí jiē qǐ】动🔱eclipse 可能会出现🔯ClassNotFoundExceptions 等错误【děng cuò wù】，所以必须在启动🔱eclipse的时候【de shí hòu】加上一个参数🐔 -clean. 这样eclipse就可以【jiù kě yǐ】更新它当前安装的许🎦多插件【duō chā jiàn】🐱信息【xìn xī】

比如你得【dé】eclipse在d盘 那么就💳是【shì】🛑 d:\eclipse\eclipse.exe -clean 

checkStyle 使用

选中工【xuǎn zhōng gōng】程🎷，右键选择checkstyle->check code with checkstyle,检查错【jiǎn chá cuò】误即可🍿

Checkstyle的结果输出

序号【xù hào】      输出内容意义⏫

1 Type is missing a javadoc commenTCLass  缺少类型说明

2“{” should be on the previous line “{” 应该位📕于前一【yú qián yī】行

3Methos is missing a javadoc comment方法前🔨面缺少javadoc注释【zhù shì】

4Expected @throws tag for “Exception”在注释中希望【zhōng xī wàng】有【yǒu】💴@throws的说明🧗

5“.” Is preceeded with whitespace “.” 前面不【qián miàn bú】能有空💨格

6“.” Is followed by whitespace“.” 后面不能有空【néng yǒu kōng】👦格

7“=” is not preceeded with whitespace“=” 前面缺【qián miàn quē】🦖少空格

8“=” is not followed with whitespace“=” 后面缺【hòu miàn quē】📂少空格

9“}” should be on the same line“}” 应该与【yīng gāi yǔ】🎏下条语【xià tiáo yǔ】句位于同一行🚢

10Unused @param tag for “unused”没有参【méi yǒu cān】🧟数“unused”，不需注【bú xū zhù】释💡

11Variable “CA” missing javadoc变量【biàn liàng】💮“CA”缺少javadoc注释

12Line longer than 80characters行长度超过【chāo guò】🗄80

13Line contains a tab character行含有【háng hán yǒu】🌔”tab” 字符

14Redundant “Public” modifier冗余的【rǒng yú de】🅿“public” modifier

15Final modifier out of order with the JSL suggestionFinal modifier的顺序【de shùn xù】👎错误

16Avoid using the “.*” form of importImport格式避免使用【miǎn shǐ yòng】🔧“.*”

17Redundant import from the same package从同一【cóng tóng yī】🐍个包中Import内容

18Unused import-java.util.listImport进来的【jìn lái de】java.util.list没有被使用🔢

19Duplicate import to line 13重复🌜Import同一个【tóng yī gè】内容

20Import from illegal package从非法【cóng fēi fǎ】包中😤 Import内容

21“while” construct must use “{}”“while” 语句缺👮少【shǎo】“{}”

22Variable “stest1” must be private and have accessor method变量“sTest1”应该是private的，并且有调用它的方法

23Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”变量【biàn liàng】🔨“ABC”不符合【bú fú hé】命名规🎪则“^[a-z][a-zA-Z0-9]*$”

24“(” is followed by whitespace“(” 后面不【hòu miàn bú】能有空【néng yǒu kōng】👁格💪 25“)” is proceeded by whitespace“)” 前面不能有空【néng yǒu kōng】👁格💪

常见提示解释：

1Type is missing a javadoc commentClass 缺少类【quē shǎo lèi】型说明🍫

2“” should be on the previous line“{” 应该位【yīng gāi wèi】🤟于前一行。解决方法【fǎ】：把🧥“{”放到上一行去【yī háng qù】🆙

3Methos is missing a javadoc comment 方法前【fāng fǎ qián】面缺少🔃javadoc注释【zhù shì】。解决方【jiě jué fāng】法：添加javadoc注释【zhù shì】 类似这👣样🏝：

/**

* set default mock parameter.（方法说【fāng fǎ shuō】明🍉）

* @param additionalParameters parameter additional(参数名【cān shù míng】称🍀)

* @return data manager(返回值说明【shuō míng】🗻)

* @throws Exception if has error(异常说明【míng】👷)

*/

4 Expected @throws tag for “Exception”在注释【zài zhù shì】中希望✊有🦈@throws的说明【de shuō míng】

解决方法【fǎ】：在方法【zài fāng fǎ】前得注释中添加这样【jiā zhè yàng】🏋一行🍭：* @throws Exception if has error(异常说明🤱)

5“.” Is preceeded with whitespace “.” 前面不能有空格【gé】。解决方【jiě jué fāng】🏆法🌈：把“（”前面的🛰空格去【kōng gé qù】掉

6“.” Is followed by whitespace“.” 后面不🔲能有空🎡格。解决方👸法【fǎ】：把“）”后面的空格去【kōng gé qù】掉【diào】

7“=” is not preceeded with whitespace“=” 前面缺少空格。解决方🕉法【fǎ】：在“=”前面加【qián miàn jiā】🔓个空格【gè kōng gé】📷

8“=” is not followed with whitespace“=” 后面缺😐少空格🤵。解决方【jiě jué fāng】法【fǎ】：在【zài】“=”后面加📴个空格

9“}” should be on the same line“}” 应该与下条语句位于同一行。解决方【jiě jué fāng】法：把【bǎ】👚“}”放到下一行的🍋前面【qián miàn】🍊

10Unused @param tag for “unused”没有参🐒数【shù】“unused”，不需注释【shì】🔑

解决方【jiě jué fāng】🎇法：“* @param unused parameter additional(参数名称【chēng】)” 把这行unused参数的😥注释去【zhù shì qù】掉🖌“

11 Variable “CA” missing javadoc变量“CA”缺少【quē shǎo】javadoc注释🥊

解决方法：在“CA“变量前【biàn liàng qián】🗓添加javadoc注释【zhù shì】：/** CA. */（注意【zhù yì】🎸：一定记🍪得加上“.”）

12 Line longer than 80characters行长度🐏超过【chāo guò】80  。解决方🧕法：把它分【bǎ tā fèn】成多行写。必要时候【hòu】，可以🚉ctrl+shift+f

13 Line contains a tab character行含有”tab” 字符。快速解决方法：可以使用EditPlus中的format功能，把tab字符转化为空格，然后保存EditPlus英文版安装文件在我机子上有。需要的可以来拷贝。注册Editplus，点击安装文件中注册的文件

14 Redundant “Public” modifier冗余的【rǒng yú de】⚓“public” modifier   。解决方【jiě jué fāng】法🥔：冗余的【rǒng yú de】⚓“public”

15 Final modifier out of order with the JSL suggestion Final modifier的顺序🎫错误【cuò wù】

16 Avoid using the “.*” form of importImport格式避免使用【miǎn shǐ yòng】🥒“.*”

17 Redundant import from the same package从同一【cóng tóng yī】个包中Import内容⛱

18 Unused import-java.util.listImport进来的【jìn lái de】java.util.list没有被【méi yǒu bèi】使用🆑。解决方法【fǎ】：去掉导😯入的多❗余的类

19 Duplicate import to line 13重复【chóng fù】🚀Import同一个内容    解决方【jiě jué fāng】🌴法：去掉导入的多余的类【yú de lèi】😚

20 Import from illegal package从非法包中 Import内容【nèi róng】❌

21 “while” construct must use “{}”  “while” 语句缺【yǔ jù quē】少🤗“{}”

22 Variable “sTest1” must be private and have accessor method变量【biàn liàng】“sTest1”应该是private的【de】🍿，并且有调用它的【de】方法🐇

23 Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”变量【biàn liàng】“ABC”不符合【bú fú hé】命名规则“^[a-z][a-zA-Z0-9]*$”解决方🌖法🏣：把这个命名改🌎成符合【chéng fú hé】规则的【guī zé de】📀命名 “aBC”

24 “(” is followed by whitespace“(” 后面不能有空【néng yǒu kōng】格🉑 25“)”is proceeded by whitespace“)” 前面不【qián miàn bú】能有空【néng yǒu kōng】格🉑

解决方法：把前面或者后面的空格去掉

25 First sentence should end with a period.解决方【jiě jué fāng】法😶：你的注释的第【shì de dì】🕕一行文【yī háng wén】字结束应该加🚩上一个"."。

26 Redundant throws catch (NumberFormatException nfe)

LOG.error("Auto Renews the agreement failed", nfe);//异常捕捉里面不能为🌊空【kōng】，在异常【zài yì cháng】里面加⛴一句话。如打印【rú dǎ yìn】等等🔇

30 '>' is not followed by whitespace.并且又【bìng qiě yòu】➰有 '(' is preceded with whitespace.

定义集🆑合和枚💪举的时🙊候的时🍲候，最后一个“>”后面要有空格【yǒu kōng gé】，“（”前面不【qián miàn bú】容许有空格【yǒu kōng gé】。解决方【jiě jué fāng】法【fǎ】：去掉泛型【xíng】🎐

31 Got an exception - java.lang.RuntimeException/k/project/" target="_blank">project. 如果不【rú guǒ bú】⬇行，可以尝【kě yǐ cháng】试⛄clean all projects, restart Eclipse.

2、因为编译好的【yì hǎo de】🏒类没有【lèi méi yǒu】在【zài】😘checkstyle的【de】🐚classpath中【zhōng】.所以💉, 只要将【zhī yào jiāng】编译好的【yì hǎo de】🏒class配置到🏻在【zài】😘<checkstyle/>的【de】🐚classpath中【zhōng】就没有这个【yǒu zhè gè】问题了📋.另外, 还发现checkstyle的【de】🐚line length好像也有点问题, 明明没有超过【yǒu chāo guò】120个字符【gè zì fú】, 却还是报错🛵.无奈😗, 我把🐣Eclipse中【zhōng】java > code style > formatter中【zhōng】的【de】⛵Maximum line with改成了🏥100, 然后format一下, 基本就没有问题了📋

32 File does not end with a newline.解决方法【fǎ】📠：删掉报【shān diào bào】💯错的类，新建一🤚个同名的类，把代码【bǎ dài mǎ】全部复制过去

33 Utility classes should not have a public or default constructor. 接口中【jiē kǒu zhōng】🏈的内部类中不应该有【yīng gāi yǒu】😆公共的【gōng gòng de】👕或者默认的构造方法

解决方法🗒：在内部类中【lèi zhōng】🍩，定义一🎐个私有🦐的构造方法🗒，然后内部类声【bù lèi shēng】📰明为【míng wéi】final类型。如果前面有【miàn yǒu】static，那么【nà me】final还必须放在📦static之后【zhī hòu】

34 Variable 'functionCode' must be private and have accessor methods.变量要【biàn liàng yào】📳改成private然后提【rán hòu tí】🏣供访问的方法

解决方法：给这些【gěi zhè xiē】变量的🤽修饰符【xiū shì fú】改成【gǎi chéng】✍private，然后提【rán hòu tí】供set，get方法，并加上对应的🚔方法javadoc注释🔀、参数注【cān shù zhù】🏒释。并在返回值和👸参数类型前添【xíng qián tiān】加final。并把调用了这🤪个变量【gè biàn liàng】🌷的地方【de dì fāng】改成【gǎi chéng】✍通过方法访问【fǎ fǎng wèn】🐁

35   'X' hides a field.

public class Foo

    private int bar;

    public Foo(int bar)

    {

        this.bar = bar;

    }

    public final int getBar()

    {

        return bar;

    }

}

全局【quán jú】private int bar;和局部🏷public Foo(int bar)的bar变量名【biàn liàng míng】字重复🏋。

解决方【jiě jué fāng】🐡法⛳：把方法【bǎ fāng fǎ】⛳里面的参数名【cān shù míng】称改变下就可🥢以了public Foo(int newBar)

    {

        this.bar = newBar;

    }。

36 Got an exception - Unexpected character 0xfffd in identifier

这是因为【wéi】🔍CheckStyle不能识别制定【bié zhì dìng】的编码格式🈯。

网上参考解决方法：

1、Eclipse中可以🌌配置【pèi zhì】📧，在Other-->checker中可以🌌指定【zhǐ dìng】

2、可以修⏲改checkstyle配置文【pèi zhì wén】🛒件【jiàn】：

<module name="Checker">

<property name="severity" value="warning"/>

<property name="charset" value="UTF-8"/>

<module name="TreeWalker">

如果是UTF-8的话，就添加🎻加粗斜体的那条语句【tiáo yǔ jù】💼，就可以【jiù kě yǐ】了【le】🈵。

37  Got an exception - java.lang.RuntimeException

    public final int getBar()

    {

        return bar;

    }

}

解释【jiě shì】🐸：public Foo(int bar)的局部变量，被认为是不可🎄改变的【gǎi biàn de】，检查🥡需要加【xū yào jiā】上final关键字定义【dìng yì】public Foo(final int bar)此错误🌐，可以忽〽略不检【luè bú jiǎn】查🥡。

2. Redundant 'X' modifier.

public interface CacheHRTreeService extends Manager {

/**

  * Organization Tree

  * @param orgDto

  * @return

  * @throws Exception

  */

public void setOrganization(OrganizationDTO orgDto) throws Exception;

/**

  * Organization Tree

  * @return

  * @throws Exception

  */

public OrganizationDTO getOrganization() throws Exception;

......

}

解释【jiě shì】：多余的字段【zì duàn】🍃。public OrganizationDTO getOrganization() throws Exception;此时public为多余🔷的字段【zì duàn】🍃，因为💁interface定义的【dìng yì de】🧡时候【shí hòu】，就是public的。

需要检查。

3. - Class X should be declared as final.

解释💹：对于单例设计【lì shè jì】模式【mó shì】，要求返🦕回唯一【huí wéi yī】的类对象💠。但是HRFactory和🏞ContextFactory为优化【wéi yōu huà】的两个类，不需求【bú xū qiú】检查🐅。

其他的单例类，依然需要进行检查。

4. - Method 'addChildrenId' is not designed for extension - needs to be

  abstract, final or empty.

解释：通过父【tōng guò fù】💾类继承🍽的【de】，此类有点特殊【diǎn tè shū】可以忽🚟略此类。

5. Variable 'id' must be private and have accessor methods.解释：BaseHRDTO类，为父类【wéi fù lèi】，属性给子类继【zǐ lèi jì】承📧，比较特殊。但是其📈他的类【tā de lèi】，声名需要加上【yào jiā shàng】🏏范围👑'private'关键字🙆。需要检查【chá】。

6. -Array brackets at illegal position.解释：代码写【dài mǎ xiě】法，习惯不一样。需要检【xū yào jiǎn】查⏳，仅仅提【jǐn jǐn tí】🌜示🎯