Intellij：将多行字符串格式化为 Javadoc 注释

Question

是否有将多行字符串格式化为 Javadoc 注释的热键？

这是一条评论

我想把它格式化为评论

请格式化

到

/**
 * This is a comment
 * I want to format it as a comment
 * Please format me
 */

cmd + / 仅将其格式化为// 注释

编辑 不知道为什么这在没有 cmets 或答案的情况下被否决，但我会更新它：

我有一个 1300 行的文件，其中包含许多字符串，所有这些都是多行的。我需要获取这些多行字符串，它们都不是 Javadoc cmets，并使其成为 javadoc cmets。我不想使用 // 我非常特别想要采用

形式的 Java 标准 Javadoc cmets

/**
 * 
 */

我试图避免超过 1300 行并手动添加注释字符串。

Answer 1

在 IntelliJ IDEA 中创建 Javadoc 的最简单方法是键入开始块注释 /**，然后按 Enter。其余代码将由 IDEA 生成。

Javadoc /**...*/ 与常规注释块 /*...*/ 的不同之处在于它还包括一些附加信息，如 @param、@return、@see 等，以及一些标签，如 {@link URL}，用于从正在运行 Javadoc。

如果你想将一些现有的注释块转换为Javadoc，你可以这样做：

1. 再添加一个星号 * 以使评论成为 Javadoc。
2. 在应记录的类、方法、函数或字段中的某处放置插入符号，然后按 Command+Shift+A 到调用Find Action 命令。
3. 在输入字段中输入fix doc comment，然后按Enter。
4. 将添加缺少的带有相应标签的文档存根。

您也可以使用 IDEA 的快速修复建议来修复您的 Javadoc，例如，当方法签名已更改时。

希望这会对您有所帮助。阅读更多Creating Documentation Comments。