Eclipse Javadoc 格式化：如何允许/禁止单行 Javadoc 注释？

Posted 2023-02-21

【中文标题】Eclipse Javadoc 格式化：如何允许/禁止单行 Javadoc 注释？

【英文标题】：Eclipse Javadoc formatting: how to allow/disallow single-line Javadoc comments?

【发布时间】：2014-12-11 04:07:40

【问题描述】：

所以，随机问题：

我有一个代码库，其中许多枚举等具有如下所示的 cmets：

public enum SomeEnum 
  /** value1 */
  VALUE1,
  /** value2 */
  VALUE2;

有没有办法强制 Eclipse 格式化程序将 Javadocs 分解为“标准”多行格式，如下所示？我当前的设置对上面的sn-p没有影响。

public enum SomeEnum 
  /**
   * value1
   */
  VALUE1,
  /**
   * value2
   */
  VALUE2;

当前行为不这样做 - 运行 Eclipse 4.4.0，并在 Javadoc 注释设置中选中以下内容：

(X) Format html tags
(X) Format Java code snippets inside 'pre' tags
(X) Blank line before Javadoc tags
(X) Indent Javadoc tags
  ( ) Indent description after @param
( ) New line after @param tags
(X) /** and */ on separate lines
( ) Remove blank lines

谢谢！

【问题讨论】：

这是 eclipse 的 cmets 代码格式化程序（包括 Javadoc）的许多错误之一。你应该打开一个错误报告here。

【参考方案1】：

解决方法：打开Find/Replace (ctrl+F) 并将\Q/**\E 放入Find 字段并将/**\R 放入Replace with 字段.然后点击Replace All。完成此操作后，激活您的格式化程序，它应该按照您想要的方式对其进行格式化。 （您所做的是在每个 Javadoc 注释的开头添加一个新行，这会强制格式化程序使用多行格式。）

【参考方案2】：

格式化程序无法将/** 和*/ 移动到不同的行可能是由于选中了格式化程序→ 注释→ 常规设置→ 从不加入行 框。

【讨论】：

感谢您的想法，但该框在我的设置中是空白的。