gofmt移除缩进式TODO格式原因及GoLand兼容问题求助

一、兼容问题解决办法 #

针对gofmt格式化后破坏GoLand TODO识别的问题，有以下几种可行方案：

1. 每行均以// TODO:开头 #

将长注释拆分为多行，每行都以// TODO:标识开头，这样既符合gofmt的新格式化规则，也能被GoLand正常识别：

// TODO: Do some stuff. And this is a long comment so it'll need to
// TODO: be wrapped. This is the next line.

2. 使用块注释替代行注释 #

块注释的缩进格式不会被gofmt修改，同时GoLand也能识别块注释中的TODO标识：

/* TODO: Do some stuff. And this is a long comment so it'll need to
   be wrapped. This is the next line. */

3. 调整GoLand的TODO识别规则 #

在GoLand的设置中，可扩展TODO的匹配规则，允许后续行带有缩进。具体路径为：Settings/Preferences > Editor > TODO，添加自定义模式匹配缩进的续行内容，比如设置匹配模式为\bTODO:\b.*并开启多行匹配。

二、TODO格式变更的原因 #

Go 1.19版本的gofmt调整注释格式化规则，是为了适配官方推出的注释文档化规范。该规范旨在统一Go代码注释的编写风格，让注释能够被工具（如godoc）正确解析并生成标准化的文档。

此前的缩进续行注释被gofmt判定为不符合新规范中的段落规则——新规范认为，带有缩进的续行属于独立段落，因此会自动插入空行分隔。这一调整本质是为了提升注释的可读性与工具兼容性，统一代码文档的生成逻辑。

内容的提问来源于stack exchange，提问作者Noel Moldvai