代码注释

行和块注释

Java 中的单行注释以两个正斜杠 (//) 开头。 要在 IntelliJ IDEA 中快速添加行注释，在 macOS 上按 ⌘ /，或者在 Windows 和 Linux 上按 Ctrl + /。

块注释或多行注释通常采用段落的形式。 存在例外，例如向代码行中间插入注释时。 在这种情况下，无论注释需要多短，多行注释都是唯一的选择。

块注释会被斜线-星号 (/) 和星号-斜线 (/) 括起来。 要在 IntelliJ IDEA 中添加块注释，在 macOS 上按 ⌥ ⌘ /，在 Windows 和 Linux 上按 Ctrl + Shift + /。

IntelliJ IDEA 中的一个快速修复可以完成行注释和块注释之间的转换。 将文本光标放在注释上，然后，在 Windows 和 Linux 上按 Alt+Enter，在 macOS 上按 Option+Enter，选择 Replace with end-of-line comment（替换为行尾注释）或 Replace with block comment（替换为块注释）。

在建议列表打开时按 F1 可以预览变更。

相同的快捷键也可以用来撤消行的注释。

注释可以在行首生成，也可以与代码对齐。 此外，您可以配置 IDE，让它在您添加新注释时于注释符号和注释文本之间添加空格。 在块注释中，文本前后都会添加一个空格。

您可以在 Preferences / Settings | Editor | Code Style | Java | Code Generation | Comment Code（偏好设置 / 设置 | 编辑器 | 代码样式 | Java | 代码生成 | 注释代码）中配置这些设置。

在即将发布的 IntelliJ IDEA 2022.1 中，我们添加了一项新功能，它可以在您于 Java、Kotlin 和 Groovy 中重新格式化代码时在行注释中添加空格。 最新的 EAP 版本已经提供功能试用。

TODO 注释

IntelliJ IDEA 默认提供两种预定义模式：包含 TODO (//TODO) 的注释和包含 FIXME (//FIXME) 的注释。 您可以使用正则表达式创建自己的模式。 为此， 请创建一个实时模板 ，将自定义 TODO 快速插入到代码中。

IntelliJ IDEA 在一个工具窗口中收集所有 TODO 注释，确保注释不会遗失在代码库中。 它们也在编辑器中高亮显示，并在编辑器右侧的错误条上标有记号。 要查看所有 TODO 注释，请从主菜单中选择 View | Tool Windows | TODO（视图 | 工具窗口 | TODO）。