如何为GoLand开发监听文件变更的自动添加文档插件？

嘿，我刚巧做过GoLand相关的插件开发，给你梳理下监听文件变更+自动加注释的核心步骤，帮你快速上手：

针对你的需求（用户输入换行/修改代码后触发），主要用文档监听（DocumentListener）或者文件系统监听（FileListener），前者更适合编辑器内的实时输入场景：

1. 注册DocumentListener监听编辑器内容变化 #

这个监听器会在用户修改编辑器内容（比如换行、输入代码）时触发，是你要的核心逻辑入口。

用Kotlin写的示例代码：

import com.intellij.openapi.editor.EditorFactory
import com.intellij.openapi.editor.event.DocumentEvent
import com.intellij.openapi.editor.event.DocumentListener
import com.intellij.openapi.project.ProjectManager
import com.intellij.psi.PsiDocumentManager
import com.intellij.psi.impl.source.tree.LeafPsiElement
import com.intellij.lang.go.psi.GoFile
import com.intellij.lang.go.psi.GoVarDeclaration
import com.intellij.openapi.application.ApplicationManager
import com.intellij.lang.go.psi.GoPsiElementFactory
import java.util.concurrent.atomic.AtomicBoolean

class MyDocumentListener : DocumentListener {
    // 用来标记是否是插件自己修改的文档，避免无限循环
    private val isPluginModifying = AtomicBoolean(false)

    override fun documentChanged(event: DocumentEvent) {
        val document = event.document
        // 先判断是否是Go文件
        val file = document.file ?: return
        if (file.fileType != com.intellij.lang.go.GoFileType.INSTANCE) return

        // 过滤掉撤销/重做、插件自身触发的变更
        if (event.isFromUndoRedo || isPluginModifying.get()) return

        // 获取当前项目和编辑器
        val project = ProjectManager.getInstance().openProjects.firstOrNull() ?: return
        val editor = EditorFactory.getInstance().getEditors(document).firstOrNull() ?: return

        // 解析PSI树，定位变更位置的代码元素
        val psiFile = PsiDocumentManager.getInstance(project).getPsiFile(document) as? GoFile ?: return
        val offset = editor.caretModel.offset
        val element = psiFile.findElementAt(offset)

        // 判断是否是新的变量声明（比如刚输入完var xxx int后换行）
        val varDeclaration = element?.parent as? GoVarDeclaration
        varDeclaration?.let {
            addDocumentComment(project, it)
        }
    }

    private fun addDocumentComment(project: Project, varDeclaration: GoVarDeclaration) {
        ApplicationManager.getApplication().runWriteAction {
            isPluginModifying.set(true)
            try {
                // 生成符合Go规范的注释，这里可以扩展成更智能的逻辑（比如根据变量类型生成描述）
                val varName = varDeclaration.name ?: "var"
                val commentText = "// $varName TODO: 补充变量描述\n"
                val commentElement = GoPsiElementFactory.getInstance(project).createCommentFromText(commentText)
                
                // 将注释插入到变量声明的上方
                varDeclaration.parent.addBefore(commentElement, varDeclaration)
            } finally {
                isPluginModifying.set(false)
            }
        }
    }
}

// 在插件初始化时注册监听器（需要传入插件的Disposable用于资源释放）
fun registerDocumentListener(disposable: com.intellij.openapi.Disposable) {
    EditorFactory.getInstance().addEditorFactoryListener(object : com.intellij.openapi.editor.event.EditorFactoryListener {
        override fun editorCreated(event: com.intellij.openapi.editor.event.EditorFactoryEvent) {
            event.editor.document.addDocumentListener(MyDocumentListener(), disposable)
        }
    }, disposable)
}

2. 用PSI解析Go代码，判断新变量 #

IntelliJ平台的PSI（Program Structure Interface）是解析各种语言代码结构的核心API，GoLand已经封装好了Go相关的PSI类（比如GoVarDeclaration、GoIdentifier），你可以通过这些类快速定位到新添加的变量，不用自己写正则匹配代码。

3. 关键注意事项 #

• 避免无限循环：插件修改文档会再次触发documentChanged，所以一定要用线程安全的标记（比如AtomicBoolean）过滤掉自身触发的事件。
• 性能优化：不要每次文档变更都全量解析PSI，只在光标/变更位置附近查找元素，减少性能消耗。
• 资源释放：监听器要绑定到插件的Disposable上，插件卸载时自动释放，避免内存泄漏。

如果想让插件在特定操作（比如按下回车）时触发，还可以结合EditorActionHandler或者KeyListener，监听回车事件后再执行PSI解析和注释插入逻辑，这样更精准。

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