我在 Eclipse 中使用 Checkstyle (Google Checks),对于每个 Javadoc 标记,编译器都会显示警告“Javadoc 标记前面应该有一个空行”,即使有一个。消除警告的唯一方法是引入 HTML 换行符。
例如:
/**
* shows drinks units in fridge.
*
* @return amount of drinks in fridge.
*/
编译器会给出警告“Javadoc 标签‘@return’前面应该有一个空行”。
当然可以在 Checkstyle 中取消激活警告,但是我仍然想知道编译器为什么会那样做。即使没有换行符,我的老师和同学也没有那个警告,他们不知道为什么我有它,在 Checkstyle ( https://checkstyle.sourceforge.io/apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/RequireEmptyLineBeforeBlockTagGroupCheck.html ) 的 sourceforge 页面上,也不需要 HTML 响应。
感谢您的帮助!
最佳答案
我意识到这是因为当您按下 enter 时 Eclipse 会自动在星号后插入一个空格(如果您要在该行上写一些东西,这是有意义的)但当您再次按下 enter 时不会删除它。所以 Javadoc 标记之前的行实际上是:<leading indentation>*<space>
.手动删除此空格会为我删除 Checkstyle 警告。
也许其他人知道如何配置 Eclipse 来自动删除这个空间。就个人而言,我坚持使用 Google's XML formatter profile因为他们的google-java-format Eclipse plugin不起作用(未处理的异常)。也许 google-java-format 可以解决这个问题。
关于java - Checkstyle 警告 Eclipse "Javadoc tag should be preceded with an empty line"即使有一个,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/69486116/