在 Eclipse 中切换 Javadoc 块注释

Question

我正在使用 apidoc.

将我的 API 文档从 Github 中的纯文本文件移动到 Javadoc 注释

所以，我已经有 API 个输出示例，我想用 javadoc 语法编写这些示例。我需要在每一行的开头添加小 * 而无需手动输入它们，因为它们很多。是否可以在 Eclipse 中执行此操作？我到处都找不到。

示例：

我要转

{
  "firstResult" : 1,
  "limit" : 30,
  "totalCount" : 2,
  "value" : [ 
    {
      "firstname" : "John",
      "name" : "Doe",
    }, 
    {
      "firstname" : "Johnny",
      "name" : "Doe"
    } 
  ]
}

进入

/**
 * {
 * "firstResult" : 1,
 * "limit" : 30,
 * "totalCount" : 2,
 * "value" : [ 
 *   {
 *     "firstname" : "John",
 *     "name" : "Doe",
 *   }, 
 *   {
 *     "firstname" : "Johnny",
 *     "name" : "Doe"
 *   } 
 * ]
 * }
 */

Answer 1

leading asterisks are optional，自 1.4 以来的每个 Java 版本中。

如果您想要它们的外观，这是一种方法。不幸的是，它需要几个步骤。

首先，粘贴您的文本。为了这个例子的目的，我们假设它只是这四行：

{
  "firstResult" : 1,
  "limit" : 30
}

现在，在顶部添加 /** <pre>。在底部，添加 </pre> */。 <pre> 标签防止自动换行破坏您的缩进和换行符，在 javadoc 创建和 Source>Format 期间都是如此。（如果您经常这样做，请考虑先粘贴所有页眉，然后再粘贴所有页脚。）

/** <pre>
{
  "firstResult" : 1,
  "limit" : 30
}
</pre> */

现在，使用 Source>Format 或其快捷键 Shift-Control-F 格式化文本。（如果您不想格式化整个文件，请先 select 您的评论。）

/**
 * <pre>
 *  {
 *    "firstResult" : 1,
 *    "limit" : 30
 *  }
 * </pre>
 */

在 Eclipse 中切换 Javadoc 块注释

Toggle Javadoc block comment in Eclipse

eclipse

formatting

javadoc

api-doc