为什么Eclipse代码格式化程序会破坏Javadoc @see标记?

时间:2008-09-05 08:12:45

标签: java eclipse javadoc eclipse-3.4

我正在使用Eclipse 3.4并配置了Java代码格式化程序,并启用了 Comments 选项卡上的所有选项。问题是,当我格式化包含以下内容的文档注释时

* @see <a href="test.html">test</a>

代码格式化程序在结束HTML中插入一个空格,将其分解:

* @see <a href="test.html">test< /a>

为什么呢?我该如何阻止这种情况发生?

通过禁用评论标签上的任何选项(例如格式HTML标记),无法解决此问题。我找到的唯一解决方法是通过禁用启用Javadoc注释格式启用块注释格式选项来完全禁用Javadoc格式,这意味着我必须格式化注释手动阻止。

3 个答案:

答案 0 :(得分:4)

我只能假设它是Eclipse中的一个错误。它只发生在 @see 标签上,它也适用于所有3种内置代码格式化设置。

附近已经报道了一些有趣的错误,但我找不到这个具体的错误。例如,请参阅Eclipse Bugzilla中搜索 @see

答案 1 :(得分:1)

严格的XML规范要求自闭标记在结束斜杠之前应该有一个空格,如下所示:

<gcServer enabled="true" /> <!-- note the space just after "true" -->

我只能假设,就像Bart说的那样,Eclipse的重新格式化程序中存在一个错误,认为结束标记实际上是一个自动关闭的标记。另一个想法:你能否验证你的 a 标签是否平衡(即文档中没有未封闭的标签)?

答案 2 :(得分:1)

这可能是Eclipse 3.4中的一个错误。我正在使用3.3(M20080221-1800),并且没有观察到这种行为。