在Eclipse中切换Javadoc块注释

Question

在Eclipse中切换Javadoc块注释

eclipseformattingjavadocapi-doc

3

我正在将我的API文档从Github的平面文本文件转移到使用apidoc的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"
 *   } 
 * ]
 * }
 */

- singe3

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Andy Thomas · Accepted Answer

自Java 1.4版本以来，每个版本中的前导星号都是可选的。

如果你想让它们出现在页面上，有一种方法。不幸的是，这需要几个步骤。

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

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

现在，在顶部添加 /** <pre>。在底部添加 </pre> */。 <pre>标签可以防止单词换行破坏您的缩进和换行，无论是在 javadoc 创建还是在 Source>Format 过程中。(如果您经常这样做，请考虑先粘贴所有标题，然后再粘贴所有页脚。)

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

现在，使用Source>Format或其快捷键Shift-Control-F对文本进行格式化。（如果您不想格式化整个文件，请先选择您的注释。）

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