当前位置:首页 > 文章列表 > Golang > Go问答 > Go ast.NewCommentMap 结果为空为什么要先检查解析模式

Go ast.NewCommentMap 结果为空为什么要先检查解析模式

来源:17golang原创 2026-11-10 18:40:37 0浏览 收藏

ast.NewCommentMap 只关联调用方传入的注释组,不会重新扫描源文件。如果解析时没有启用 parser.ParseComments,通常作为第三个参数传入的 file.Comments 就没有注释组,结果为空是正常的输入结果。因此应先检查解析模式和注释列表,再排查节点关联规则。

官方文档:https://pkg.go.dev/go/parser#Mode;注释映射:https://pkg.go.dev/go/ast#NewCommentMap。

先看注释有没有进入 AST

假设一个源码整理工具读到了 var 声明,却怎么也找不到旁边的说明文字。这时我会先看 ParseFile 的 mode,而不是先调整 NewCommentMap 的根节点。源码字符串里有注释,并不代表解析结果已经保留了注释。

ParseComments 控制注释进入 AST。NewCommentMap 的三个参数分别提供位置表、关联范围的语法根节点和注释组列表。它没有文件名或源码内容参数,职责是建立关系,而不是补做词法扫描。

解析模式与注释映射输入的关系
图1:静态输入说明图,NewCommentMap 关联已提供的注释组,不重新读取源码补回注释。

用两种解析模式对照输入

下面的原创示例只改变解析模式,用同一源码比较 file.Comments 与映射键的数量。代码没有执行,文中不提供冒充实际日志的输出。两次解析分别创建位置表,并始终把各自的表与 AST 配对。

package main

import (
 "fmt"
 "go/ast"
 "go/parser"
 "go/token"
)

func main() {
 // 同一源码分别演示不保留与保留注释的解析方式。
 const source = `package sample
// Count 表示计数。
var Count = 1 // 初始计数
`
 modes := []struct {
  name string
  mode parser.Mode
 }{
  {"未开启注释", parser.SkipObjectResolution},
  {"保留注释", parser.SkipObjectResolution | parser.ParseComments},
 }
 for _, item := range modes {
  // 每份 AST 与它自己的 FileSet 配对,不混用位置记录。
  fset := token.NewFileSet()
  file, err := parser.ParseFile(fset, "sample.go", source, item.mode)
  if err != nil {
   fmt.Println("解析失败:", err)
   return
  }
  comments := ast.NewCommentMap(fset, file, file.Comments)
  fmt.Printf("%s: 注释组=%d 关联节点=%d\n",
   item.name, len(file.Comments), len(comments))
 }
}

第一种模式没有 ParseComments,不保留这里的注释。第二种模式使用按位或叠加 ParseComments,会保留声明前和行尾的注释组。模式位是可以组合的,不应为了保留注释而不小心覆盖已有的其他模式配置。

SkipObjectResolution 跳过已弃用的标识符对象解析,和是否保留注释是两件事。也不要把 AllErrors 当成注释开关:它影响错误报告范围,不负责把注释加进 AST。

保留同一位置上下文建立关联

确认注释组非空后,再看 FileSet 是否对应当前 AST,第三个参数是否真的传入 file.Comments,以及根节点是否是预期分析范围。混用不同解析任务的位置值,会让关联依赖的位置解释失去一致性。

注释关联的上下文与结果组成
图2:静态结构说明图,位置表、语法节点与注释组应来自一致的解析上下文。

CommentMap 根据注释组与语法节点的行位置进行关联,并倾向于关联到较大的节点。例如赋值语句后的行尾注释,可以归到整条赋值语句,而不是最后一个操作数。不能因为在某个细小表达式键下查不到注释,就判断整个映射为空。

如果先改写或删除节点,再用旧节点地址查映射,也可能与预期不同。对重写工具,我会保留明确的关联更新策略;NewCommentMap 不是持续监听 AST 变化的对象。它只能基于给定节点与注释位置建立当前关系。

区分空映射与没有文档注释

观察项含义下一步
file.Comments 为空关联输入没有注释组看 ParseComments、源码和解析错误
map 的某个节点键不存在该节点未直接关联组看关联范围和较大节点
len(map) 较小键是关联节点不要当作注释条数
某声明 Doc 为 nil该文档注释字段未关联组不能据此认定文件没有注释

len(CommentMap) 统计关联节点的数量,不是注释文本行数,也不是注释组数量。同一个节点可以关联多组注释,读取时应使用对应的组列表。文件里的独立注释、行尾注释与声明的 Doc 字段,也不应被混为一种数据。

解析返回错误时,ParseFile 可能给出部分 AST,工具必须说明是否接受部分结果。不要忽略错误后,把缺失注释都归因于模式。需要完整文件信息时,也要注意 PackageClauseOnly、ImportsOnly 这样的选项会限制解析范围。

常见问题:源文件没有注释时映射为空正常吗?正常。开启 ParseComments 就能获得作者的语义关联吗?不能,它按位置规则组织,不理解自然语言含义。只提取注释文字需要建 map 吗?不一定,直接遍历 file.Comments 更贴近需求;需要知道注释关联哪个语法节点时再建映射。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
Go 泛型 Named.Obj 与 Origin.Obj 应该怎样选择Go 泛型 Named.Obj 与 Origin.Obj 应该怎样选择
上一篇
Go 泛型 Named.Obj 与 Origin.Obj 应该怎样选择
Go ast.FieldList.NumFields 怎样统计合并声明的参数数量
下一篇
Go ast.FieldList.NumFields 怎样统计合并声明的参数数量
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    968次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    977次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    1085次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    1061次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    899次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码