Checkstyle与Oracle Java Style Guide冲突

时间:2012-02-14 06:25:59

标签: java checkstyle

我正在学习一门需要使用Checkstyle的课程。我对它似乎正在执行的“惯例”感到很困惑。

例如:

/**
 * Something, something.
 *                        <-- NOT ALLOWED
 * @param bla bla bla
 */

根本不允许使用三元运算符,并且每个if语句都需要括号。

这些“惯例”似乎与Oracle风格指南相冲突:http://www.oracle.com/technetwork/java/codeconv-138413.html

我认为关于样式指南的想法几乎和程序员一样多,但这套规则来自哪里,并且Checkstyle规则有哪些特别优势?

1 个答案:

答案 0 :(得分:0)

您应该与课程协调员核实,以确保您使用的是正确的Checkstyle规则集。如果您是,那么您需要询问他们为什么他们选择了具有这些特定限制的规则集。

但最重要的是,对于Java风格和布局有很多意见,你只需遵守课程强加给你的规则......以及将来,你的项目经理,等等。


我可以看到这些特定示例规则的参数:

  • javadoc中的空白行是浪费屏幕空间
  • 三元运算符倾向于在使代码可读性降低的地方使用。
  • 始终使用带有if语句和循环体的'{''}'的规则可以避免因不一致缩进而隐藏的错误。 (有了括号,不一致就更明显了。)