checkstyle对检查代码规范问题的总结,虽然还不够只能,但已经比较强大。
1.Cyclomatic Complexity is X (max allowed is X).
问题说明:圈复杂度过高。所反映的是“判定条件”的数量。圈复杂度大说明程序代码可能质量低且难于测试和维护。
修改建议:降低判定条件的数量。对方法进行拆分。
2.Nested if-else depth is X (max allowed is X).
问题说明:if-else嵌套太多
修改建议:把嵌套的逻辑用一个分支或多个分支来实现
3.Line matches the illegal pattern 'X'.
问题说明:含有非法字符,一般是system类的东西,程序提交时进行删除。
4.Must have at least one statement
问题说明:空语句。必须添加业务逻辑。有时每行后不小心添加一个【;】,或者异常处理没有进行。
5.Empty statement
问题说明:空语句。必须添加业务逻辑。
6.Literal Strings should be compared using equals(), not 'X'.
问题说明:字符串比较不能用==,用equals
7.switch without "default" clause.
问题说明:switch语句判断没有default的情况处理。
8.Found duplicate of X lines in X, starting from line X
问题说明:包含有重复的语句,应该提取公共方法。
9.Assignment of parameter 'X' is not allowed.
问题说明:不允许对函数的参数进行修改。
10.'X' is a magic number.
问题说明:对于直接用代码中的数字,进行常量的定义。
11.Missing a Javadoc comment.
问题说明:缺少javadoc的注释。
12.Expected X tag for 'X'.
问题说明:注释中缺少对变量,异常,返回值的说明
13.Name 'X' must match pattern 'X'.
问题说明:变量不符合命名规则
14.其他的都比较好理解。对于类,方法长度的控制,注释中各参数的说明等。
问题说明:比较难于修改的为圈复杂度过高,以及嵌套if-else的问题,需要根据实际的业务逻辑进行拆分方法,并进行方法参数的传递。
而对于圈复杂度过高,判断较复杂(if -elseif -elseif ...,switch case较多的判断)修改时还没有合适的方式。
分享到:
相关推荐
除了在IDE中使用Checkstyle外,还可以在构建过程中集成Checkstyle,确保每次构建时都能自动运行代码检查。 ##### 1. 添加Checkstyle依赖 在项目的 `pom.xml` 文件中添加Checkstyle的Maven插件依赖: ```xml ...
CheckStyle 是一个流行的 Java 代码检查工具,通过检查 Java 代码的格式、结构和语法错误来提高代码的质量和可维护性。CheckStyle Xml 文件是 CheckStyle 工具的配置文件,用于定义检查规则和参数。本文将对 ...
总结来说,CheckStyle-IDEA插件是Java开发者必备的工具之一,它能够帮助我们保持代码的整洁和一致性,提高代码质量。通过离线安装包`checkstyle-idea-4.10.0.zip`,我们可以方便地在IntelliJ IDEA中使用CheckStyle...
1. **激活代码检查**:右键点击项目 -> `Properties` -> `CheckStyle`,勾选 “CheckStyle active for this project” 以开启代码检查功能。此时会在项目目录下生成 `.checkstyle` 文件,记录文件集配置信息及代码...
Checkstyle通过扫描源代码,检查各种编程细节,如代码格式、命名规则、异常处理、注释规范等,帮助开发者发现并修正潜在的问题。它支持自定义规则集,可以根据团队或项目的特定需求来设定检查标准,从而提高代码的...
### 解决Checkstyle出现的问题:Got an exception - java.lang.RuntimeException: Unable to get class information for Exception 在开发过程中,我们可能会遇到使用Checkstyle时出现的异常情况,例如:“Got an ...
Checkstyle是一款强大的静态代码分析工具,它能够检查代码是否符合设定的编码标准,帮助开发者提前发现潜在的问题。MyEclipse作为流行的Java集成开发环境,集成了Checkstyle功能,使得在开发过程中可以实时检查代码...
如果项目使用了Maven或Gradle等构建工具,可以在构建脚本中配置Checkstyle插件,使代码检查成为构建过程的一部分,确保提交的代码符合标准。 三、Checkstyle规则详解 Checkstyle的规则包含多个类别,如命名、导入...
CheckStyle是一款开源的Java程序代码检查工具,能够自动地检测代码是否符合预定的编码规范。它可以集成到Eclipse等IDE中,也可以作为Ant任务集成到构建过程中。CheckStyle支持自定义规则集,允许用户根据项目需求...
总结来说,静态代码检查工具是提升代码质量、保证项目健康度的重要工具。通过在开发过程中集成并使用这些工具,可以有效地发现并解决代码中的问题,从而降低软件维护成本并提高开发效率。FindBugs、CheckStyle和PMD...
Checkstyle是一款广泛使用的Java编程规范检查工具,它可以帮助开发者遵循特定的编码标准和最佳实践,以保持代码的一致性和可读性。这个“绿色checkstyle”版本可能是指它是一个简化版或者精简版,便于用户下载和使用...
通过上述步骤,您可以成功地在MyEclipse环境中安装并配置CheckStyle插件,帮助您遵循统一的编码规范,提高代码质量。值得注意的是,编码规范不仅仅是为了满足检查工具的要求,更重要的是培养良好的编程习惯,提升...
Checkstyle作为一款强大的静态代码分析工具,可以帮助开发者遵循一定的编码规范,提高代码质量。而将其集成到Eclipse这一流行的集成开发环境中,则能进一步提升开发效率。本文将详细介绍如何在Eclipse中安装和配置...
Checkstyle 是一个强大的开源代码检查工具,主要用于确保代码遵循特定的编码规范和风格。它能够帮助开发者维护一致的代码质量,提高代码可读性和可维护性。Checkstyle 可以集成到开发环境中,如 Ant、Maven 或者 IDE...
Checkstyle是一款广泛使用的...总结,Checkstyle通过配置文件实现对Java代码的严格检查,帮助团队维护一致的代码风格,提高代码质量。了解和熟练运用Checkstyle的配置,对于提升软件开发的效率和可维护性具有重要意义。
Checkstyle是另一个流行的静态代码检查工具,主要用于检查代码是否符合特定的编码风格和最佳实践。它支持各种编码规范,如Sun Microsystems的Java编程规范。通过使用Checkstyle,开发者可以保持代码的一致性,提升...
总结来说,"checkStyle的使用"涵盖了如何在Eclipse中安装、配置和使用Checkstyle进行源代码质量检查。通过遵循编码规范,开发者不仅可以编写出更易于理解和维护的代码,还能提高团队间的代码一致性,降低维护成本。...
通过定义一组规则,Checkstyle 可以检测出代码中的潜在问题,如命名不规范、未使用的变量、缺少注释等。 1. **安装 Checkstyle**: 在 Eclipse 中,打开 "Help" -> "Eclipse Marketplace",搜索 "Checkstyle" 并...