问题标签 [checkstyle]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
3 回答
6789 浏览

checkstyle - checkstyle 中的 JavadocPackage 使用

我正在将我的 checkstyle 4.0 版配置转换为 5.0 版。因此,我添加了以下内容来替换旧的“PackageHtml”,

<module name="JavadocPackage"> <metadata name="com.atlassw.tools.eclipse.checkstyle.lastEnabledSeverity" value="info"/> <property name="allowLegacy" value="true"/> <property name="severity" value="info"/> </module>

发生的情况是,我收到一条信息消息,上面写着“缺少 package-info.java”,即使我的 java 文件顶部有以下注释,

/* * File: Test.java * System: PF Tools * Module: com.research.usage * Author: jadaaih * Copyright: Jadaaih * Last modified by: jadaaih * Date: 2009-03-02 15:30:24 * Version: 1.1 * Description: * Preconditions: */

很抱歉显示失真,评论末尾有换行符。

请告知如何在与 4.0 兼容的 Checkstyle 5.0 中删除该 checkstyle 信息消息。

0 投票
2 回答
220 浏览

version-control - Checkstyle 源代码控制集成

作为对标准编码约定的一些研究的一部分,我最近一直在研究 checkstyle。尽管它似乎非常适合全新的项目,但它似乎对现有项目的采用存在巨大障碍,因为它似乎不提供仅检查新代码或已编辑代码的方法。也许我错了?

如果您有一个从未有过编码标准的代码库,那么一次将整个代码库与一个标准内联可能需要付出巨大的努力。随着代码的自然发展,允许它随着时间的推移逐步完成似乎是一种更合理的方法。但是checkstyle似乎不太可能。

我认为这必须与源代码控制系统相关才能成为可能。Checkstyle 是否可以做到这一点,或者是否有其他工具可以提供此功能?

0 投票
1 回答
2116 浏览

eclipse - 您如何从 checkstyle.xml 转换为 eclipse 代码样式格式/配置文件并再次转换回来?

我有 Eclipse 代码格式化程序和配置文件 xml 文档,我想构建一个 checkstyle.xml,我可以在我的 Maven 构建中使用它来运行报告并生成 Eclipse 文件。 maven-eclipse-plugin似乎能够从 checkstyle.xml 生成 eclipse 文件(我认为),但我不知道如何走另一条路,我不期待手动完成。

如果数据从 checkstyle -> eclipse 通过 maven 流动,它应该以相反的方向流动。

有谁知道如何从 2 个 eclipse 文件中生成 checkstyle.xml ?

0 投票
1 回答
3802 浏览

deprecated - Can I disable CheckStyle complaints for deprecated methods and classes?

I'm maintaining an API that has deprecated some public static fields.

CheckStyle complains loudly about these but I'd rather have it ignore them completely since I've dealt with the problem by marking the fields as deprecated.

Specifically, the library has constants for enumeration (public static final) but the they are not marked as final. CheckStyle will complain about them, but I can't just change them to final without breaking the contract.

My plan is to mark them as deprecated and then delete them later. But marking them as deprecated doesn't remove them from the CheckStyle Report.

0 投票
4 回答
257 浏览

java - 清理代码会破坏二进制兼容性

我正在做一个被我不认识的人使用的项目。我们在降低 CheckStyle 警告方面做得相当不错,而且在不破坏二进制兼容性的情况下,它会达到一个低水平。

大多数剩余警告是由缺少 final 关键字的常量(public static final)引起的。常量的命名清楚地表明开发人员希望它们是只读的,但它们根本没有最终定义。

除非开发人员正在编写一些非常糟糕的代码来利用这种疏忽,否则如果我们添加它们,他们的代码不会中断。

当前版本号为 1.2.1。您会应用更改并转到 2.0,还是应用更改并将其作为 1.3 推出。需要完整的 2.0 似乎是一个很小的变化。

我该怎么办?

0 投票
5 回答
1397 浏览

java - 是否应该启用 Checkstyle 中的 RequireThis 检查?

内置的 Checkstyle 检查之一是RequireThis,只要您不预先this.添加到本地字段或方法调用,它就会关闭。例如,

我正在为这种检查是否合理而苦苦挣扎。在上面的例子中,ExampleClass是最终的,它应该保证getMeSomething应该调用的“正确”版本。此外,在某些情况下,您可能希望子类覆盖默认行为,在这种情况下,要求“this”是错误的行为。

最后,这似乎是一种过度防御性的编码行为,只会使源代码变得混乱,并且更难看到实际发生的事情。

因此,在我向我的架构师建议启用这是一个错误的检查之前,我想知道是否有其他人启用了此检查?您是否因丢失而发现严重错误this

0 投票
1 回答
6876 浏览

java - 有没有办法强制 Checkstyle 忽略源代码中的特定警告?

PMD 有一种方法可以忽略//NOPMDJava 源文件中带有注释的特定警告。

Checkstyle 有类似的选项吗?

0 投票
2 回答
777 浏览

regex - StackOverflowError 与 Checkstyle 4.4 RegExp 检查

你好,

背景:

我正在使用带有 RegExp 检查器模块的 Checkstyle 4.4.2 来检测 java 源头文件中的文件名何时与它们所在的类或接口的文件名不匹配。当开发人员将标头从一个类复制到另一个类并且不修改“文件:”标签时,可能会发生这种情况。

RexExp 检查器中使用的正则表达式已经经历了很多次化身,并且(尽管此时它可能有点矫枉过正)看起来像这样:

我正在检查的文件的基本形式(尽管已大大简化)如下所示

问题:

没有找到匹配项时(即当包含“File: Bar.java”的标头被复制到文件 Bat.java 中时)我在很长的文件上收到 StackOverflowError(我的测试用例是@1300 行)。

我已经尝试了几个可视正则表达式测试器,并且可以看到,在不匹配的情况下,当正则表达式引擎通过包含类或接口名称的行时,它会在下一行再次开始搜索并进行一些回溯,这可能会导致 StackOverflowError

问题:

如何通过修改正则表达式来防止 StackOverflowError

是否有某种方法可以修改我的正则表达式,以便在不匹配的情况下 (即,当包含“文件:Bar.java”的标头被复制到文件 Bat.java 中时)匹配将在检查包含的行时停止接口或类名,并看到“\1”与第一组不匹配。

或者,如果可以做到这一点,是否可以最小化在检查包含接口或类的行之后发生的搜索和匹配,从而最小化处理和(希望)StackOverflow 错误?

0 投票
3 回答
2176 浏览

java - 如何确保我的所有源文件都附有版权声明以进行 java-maven 构建?

人们是否有一种标准方式强制在他们的 java/maven 构建中包含版权声明?我意识到这不是必需的,因为产品本身是抄写的,如果有人有我的来源,我会有更大的问题,但我被要求检查并想知道 checkstyle、PMD 或其他东西是否自动处理了这个.

是否有处理版权检查的工具?

0 投票
1 回答
8369 浏览

javascript - 超越 JSLint 的 JavaScript 代码检查

我正在寻找类似 Checkstyle for JavaScript 的东西。我知道 JSLint 并且我已经在使用 Google 的 Closure 编译器,但是这些主要检查语法问题。Checkstyle 可以检查错误行上的大括号,但它也可以编写自定义检查,例如不使用 HashMap。

我正在为即将到来的 JavaScript 项目寻找类似的东西。有任何想法吗?