IntelliJ：如何保持简短的单行 JavaDoc 多行？

Posted 2023-02-21

【中文标题】IntelliJ：如何保持简短的单行 JavaDoc 多行？

【英文标题】：IntelliJ: How to keep short one-line JavaDoc multiline?

【发布时间】：2022-01-18 00:09:00

【问题描述】：

我正在尝试为 JavaDoc 设置我的 IntelliJ IDE。我面临的问题是，格式代码按钮不断将我的短多行 JavaDoc 更改为单行 JavaDoc。

例如：

/**
 * Shot description
 */

被格式化为

/** Short description */

对于我们公司的代码样式，即使描述很短，我们也希望保持多行。我在 IntelliJ 中找不到正确的设置来阻止它更改它。 （我确实看到了“不要换行 cmets”的选项，但检查它对这种情况没有帮助——我的评论仍然改为单行。

有没有办法阻止 IntelliJ 这样做？谢谢！

【参考方案1】：

设置（macOS 上的首选项）|编辑 |代码风格 |爪哇 | Java文档 |其他 | 不要将一行 cmets 换行。

【讨论】：

感谢您回复@CrazyCoder。正如我在问题中提到的，这个设置没有帮助——无论是否检查，IntelliJ 仍然将我的 JavaDoc 压缩成一行。

我在发布答案之前验证了它在 IntelliJ IDEA 2021.3 中可以正常工作。确保您不使用任何第三方格式化程序插件或 EditorConfig 覆盖。

啊，我明白了——这确实是 google-java-format 插件强制使用单行 JavaDoc。谢谢！