Checkstyle和PMD仅作为建议

Question

我如何设置使用pmd和checkstyle结果仅作为建议，并在构建服务器上禁用它们？那么这样做会不会是一种不好的做法呢？

测试中的类需要用mock对象填充其字段，这些对象不会在测试中的任何地方使用，但需要用@mock声明和注释，以使测试中的类正确工作。添加@SuppressWarnings（“pmd.unusedPrivateField”）。

在测试类中，我将有方法从一长串参数创建对象，例如：createPerson（String firstname,String lastname,int shoesize,String favouritecolor,...）。这些对象通常是从数据库或XML创建的。添加@SuppressWarnings（“pmd.ParameterNumberCheck”）。

有时我的文档会是：“这个方法确保以下3种情况下的X：\n...”。显然这是不允许的，因为第一句应该以句号结尾。

父类X有一些它的所有子类都需要和使用的字段y，但是checkstyle不允许它，除非通过方法（getY（））访问该字段。这太不自然了，伊莫。

一个选择是永久关闭造成最大麻烦的支票，然而支票可能是一个麻烦或非常有用，取决于上下文。我认识到，在代码中显式地抑制警告也是一种记录只有在特定上下文中，检查才是不相关的和恼人的方式。让我恼火的是抑制的数量，几乎每个testclass都需要抑制，而其他一些类需要变通方法。

那么，生成警告，但不允许checkstyle和pmd违规导致te构建失败，这会是一种解决方案吗？

Answer 1

测试类包含...
一个正在测试的类...
在测试类中...

在我看来，您应该在您的测试代码下抑制这些检查，因为您不同意它们。

这是一种常见的情况，就像在Checkstyle中，我们不记录我们的测试代码，但是我们的主代码记录了所有的东西。为了解决PMD的问题，我们将配置划分为test和main。为了避免Checkstyle实用程序出现这种情况，我们取消测试目录的违规。您还可以查看检查的选项，并查看是否有配置它以忽略您的案例的方法。

因为我不知道你的方法的内容，所以我不能肯定地说，但是第一句应该是简单地解释方法的作用和目标。然后你可以按照你提到的具体案例来进行。Checkstyle只是要求第一句以句点结束，而不是每句都要结束。

父类X有一些它的所有子类都需要和使用的字段y，但是checkstyle不允许它，除非通过方法（getY（））访问该字段。这太不自然了，伊莫。

既然您完全不喜欢这样，那么只需禁用对受保护字段的检查。如果查看VisibilityModifier的文档，可以将ProtectedAllowed更改为True并使其忽略这些特定情况。

我发现我的代码收集了很多尝试处理一些警告的lint。

在我看来，你似乎没有根据自己的喜好定制这些工具，只是试图使用默认配置。