Intellij：如何在 Javadoc 中包装一段文本？

Posted 2023-02-21

【中文标题】Intellij：如何在 Javadoc 中包装一段文本？

【英文标题】：Intellij: How can I wrap a piece of text in Javadoc?

【发布时间】：2017-09-28 14:28:03

【问题描述】：

因此，例如，如果我要从 Web 上的某个外部来源为字段插入 Javadoc 注释，我将从网站复制粘贴相关部分，然后转到我的类以将复制的内容合并为字段的 Javadoc 注释。

但问题是，我找不到 Intellij 对此的任何支持。目前，我必须输入 /** + Enter 来生成一个存根，然后将内容粘贴到那里，但没有正确粘贴 - 我的意思是，一段 5 行作为一条长线出现，旁边的 Javadoc * 消失了.

我一直在寻找类似的东西，将原始复制的内容粘贴到该位置然后选择它，如果 Intellij 提供了一些快捷方式将其包装为 Javadoc 注释，请执行此操作，除非我找不到 Intellij 对这种方法的任何支持.

所以我的问题是，是否有人知道任何此类工具/插件/内置 Intellij 支持或任何其他解决方法，因为这很耗时？

【问题讨论】：

您可以粘贴它，突出显示它，按ctrl + / 评论它，然后在/* 上加一颗星吗？

Ctrl + / 生成单行 (//...) cmets 并且在最左侧也是如此。

你可以高亮全//的文本，在选择中用*替换//，然后手动修改开闭分隔符。

@byxor ：这也很耗时。此外，它不会创建专业的 Javadoc。我刚刚尝试了您的建议-您可以自己检查。

除了内容之外，是什么让 javadoc 评论变得专业？我正在提供一种方法来“包装”您在评论中想要的任何文本

【参考方案1】：

您必须从 /** 和 Return 开始才能获得基本的 javadoc 注释。然后，您可以在光标定位时使用 ctrl+V （在 OSX 上为 ⌘+V）粘贴文本在正确的地方。

剩下的就是使用为重新格式化而定义的键盘快捷键。在菜单中，您会发现在 _Code/重新格式化代码 下，在我的 Mac 上是 ⌘+⌥+L.

【讨论】：

不幸的是，这不适用于多行文本