没有不值得去解决的问题,也没有不值得去学习的技术!

代码块里的注释为什么不能只靠肉眼检查?v2 如何统计并验证代码注释翻译完整性

v2 代码注释完整性审计流程图:从源页面建立代码块清单,分类教学注释、机器语义和无法判断的内容,再与当前译文精确对应,确认 missing、extra 和 protected mutation 均为 0。

作者:

在

系列帖子

Markdown Page 经过 Parse / Protect、Generation 和 Reconstruct / Validate 的流程示意图,强调保护 inline code、链接、代码等机器语义,同时允许译文按照自然语言调整语序。

(1) Markdown 不是纯文本:Learn / Docs 为什么需要新的 parser 与结构保护

图3:访问过去的 Go Tour 简体中文站 tour.go-zh.org 时,当前已经无法正常建立连接。

(2) 从「A Tour of Go 中文版」这个搜索词开始:我决定做一个持续维护的 Go Tour 中文版

本地运行的 A Tour of Go「Methods continued」课程页面,左侧为课程说明,右侧为 Go 代码编辑器及运行结果。

(3) A Tour of Go 中文版项目设计冻结:从 101 页到 103 页,从 Gin 转向 Cobra CLI

A Tour of Go 中文版开发实战:英文基线、在线运行与 101 页上游同步体系

(4) A Tour of Go 中文版开发实战:英文基线、在线运行与 101 页上游同步体系

go-tour-i18n 项目完成首个简体中文课程页面 welcome/1 的整页翻译、结构校验和本地预览。

(5) A Tour of Go 多语言翻译项目实录:完成首个 zh-CN 页面翻译闭环

图 1:DeepSeek 官方更新日志显示,本次只更新 DeepSeek-V4-Flash,DeepSeek-V4-Pro API 与 APP、Web 模型均未更新

(6) A Tour of Go 中文翻译项目进展:完成前 8 页、修复 present 语法,并暂缓 DeepSeek 对比

图 1:generics/1 简体中文页面本地预览

(7) 一个页面重试五次:使用 GLM-5.2 翻译 A Tour of Go 时遇到的 Token 与 Present 结构问题

图 1:methods/16 简体中文页面浏览器预览

(8) A Tour of Go 中文翻译实录:如何只翻译教学代码注释,而不破坏 Go 代码

图 2:A Tour of Go methods/20「练习:错误」中文候选页面最终渲染效果

(9) A Tour of Go 多语言翻译:当正确的中文语序被受保护标记顺序校验误判

图 3:methods/24 中文页面,静态代码、Bounds 行内代码和链接内的 image.Rectangle 均正确渲染

(10) A Tour of Go 中文翻译完成 7 个代表页校准:最后 3 页又发现了哪些真实问题

图 2:首批 10 个普通页面经过试跑与流程校准后全部进入 ready

(11) A Tour of Go 多语言翻译项目:首批 10 个普通页面试跑,从 2 个 blocked 到全部 ready

图 2:flowcontrol/6 最终中文页面,return 与 v 为适应自然中文语序发生整体换位

(12) A Tour of Go 中文翻译第二批实跑:从 Inline Code 顺序误判到历史响应重新验证

图 1:flowcontrol/6 首次原始输入实验直接通过统一自动校验

(13) A Tour of Go 多语言翻译项目:从 swap 问题重新审视 Token 保护,原始输入与最小保护的一次真实实验

图 7:moretypes/1 最终中文页面预览。左侧课程正文、静态代码块、行内代码和教学注释均正常渲染,右侧官方 Go 示例继续保持原样。

(14) A Tour of Go 多语言翻译实战:第三批 10 页全部 Ready,继续校准 Protected Token 的结构角色

图 4:上游源码确认共有 103 个课程页面,zh-CN 最终达到 ready=103、pending=0、blocked=0

(15) A Tour of Go 多语言翻译项目:zh-CN 103 个课程页面全部 ready,课程正文翻译阶段完成

图 4:GitHub 与 ChatGPT 已成功连接

(16) ChatGPT 连接 GitHub 实测:让 AI 直接读取 go-tour-i18n 仓库参与译文审核

图 3:中文 Go 术语校准完成后,将确定的译法写入 zh-CN glossary

(17) 为什么 channel 最终选择“通道”:A Tour of Go 中文术语统一的一次实践

图 1:技术含义基本正确,但“返回一个返回……”已经明显影响阅读,因此仍被列入 C 类修订

(18) 103 页逐页审核后,只返修 16 页:A Tour of Go 中文正文发布前质量审计

图 2:中文课程页面以及已经完成本地化的编辑器控制区

(19) A Tour of Go 多语言翻译项目:公共 UI 本地化完成,从课程译文走向完整中文界面

图 2:完整 zh-CN 正式投影成功生成,103 个课程页面被重新组装为 7 个 .article

(20) 从 103/103 ready 到完整站点验收:A Tour of Go 中文版补齐正式投影与课程元数据本地化

图 3:从 production bundle 独立启动的 A Tour of Go 简体中文页面,课程正文、公共 UI 和官方 Go 示例均已进入最终发布形态。

(21) A Tour of Go 多语言翻译项目:103 页全部完成后,我终于生成了可独立部署的 zh-CN Production Bundle

图 1:A Tour of Go 简体中文版正式生产页面,远程运行已经成功输出“Hello, 世界”。

(22) A Tour of Go 多语言翻译项目:zh-CN 正式上线,从生产发布到 go.dev Playground 的完整部署记录

图 1:新生产域名 go-dev.shuijingwanwq.com 已正常访问,Go 示例远程运行成功

(23) A Tour of Go 多语言翻译项目:从 go-tour 到 go-dev,完成 EdgeOne、Nginx 与 HTTPS 生产域名迁移

图 1:A Tour of Go 多语言翻译项目正式生产首页

(24) A Tour of Go 多语言翻译项目正式上线:从项目首页、公共 Footer 到生产发布元数据的完整收尾

图 3:GA4 g/collect 请求返回 HTTP 204,并携带当前课程页面地址,确认 Google Analytics 已产生真实事件上报

(25) A Tour of Go 多语言翻译项目:接入 Google Analytics 与百度统计,从 systemd 注入到 EdgeOne 与真实上报验证

图 1:生产环境 robots.txt 与 sitemap.xml 已正确对外提供,Sitemap 共包含 104 个规范 URL。

(26) A Tour of Go 中文站上线后:补齐 robots.txt、Sitemap,并完成五大搜索引擎提交

图 4:发布生产并刷新 EdgeOne 缓存后,再次通过真实手机访问,顶栏项目名称已经完整保持在一行,最终移动端验收通过。

(27) A Tour of Go 多语言翻译项目:修复手机端首页顶栏标题换行,并完成真机验证

图 3:生产自动部署脚本第一次真实运行时,systemd 已经显示 active,但首次 localhost 探测仍然得到 HTTP 000;随后连续 3 次同时满足 active + HTTP 200 后,脚本才判定部署成功,并继续完成公网 HTTP 200 验收。这次真实运行验证了连续应用层健康检查的必要性。

(28) A Tour of Go 多语言翻译项目:从一次 203/EXEC 故障到生产自动部署脚本落地

图 1:阿里云生产环境访问 go.dev Playground 时出现 TLS 握手超时

(29) A Tour of Go 多语言翻译项目:为 Playground 搭建独立的 ZgoCloud 执行代理

图 3:清除 /tour/script.js 缓存后,Run 已直接请求 ZgoCloud /compile 并返回 HTTP 200

(30) A Tour of Go 多语言翻译项目:将生产 Run / Format 切换到 ZgoCloud 执行节点

【图 1:微信中运行 Go 示例时出现 Error communicating with remote server.】

(31) A Tour of Go 中文版手机端运行与格式化偶发失败排查:从间歇性报错到补强 Nginx 可观测性

【图 4:向 golang-dev 公开邮件列表发送 Playground 使用告知邮件并投递成功】

(32) A Tour of Go 多语言项目:为 Playground 代理增加唯一 User-Agent,并主动告知 Go 官方

【图 3:百度剩余 9 个核心 URL 提交成功,remain 归零】

(33) A Tour of Go 搜索引擎收录实测:从 Google 自然索引到百度主动提交与 Bing IndexNow

【图 1:当前正式中文 methods/24 页面,右侧示例代码运行成功】

(34) A Tour of Go 中文翻译完成后,我为什么重新评估 minimal-protect 翻译模式

【图 3:5 个页面 Request SHA256 完全一致,但 Response SHA256 全部不同】

(35) A Tour of Go 翻译实验:更多原始上下文为什么没有更好?从 157 个保护标记到 30 次重复盲评

图 3:3 个代表页 × 4 个评审模型,共 12 次匿名评审的完整排名与第一名票数。

(36) A Tour of Go 翻译质量再评估:minimal-protect 未达预期后,我开始比较 ChatGPT、Codex 与 GLM-5.2

图 2:GitHub 中的 chatgpt-zh-CN-008 重译批次。一个 Batch 同时保存 inputs、raw-responses、candidates、validation 和 retry 记录,GitHub 成为 ChatGPT 与本地翻译流水线之间的数据交接层。

(37) 没有 OpenAI API,我如何用 ChatGPT + GitHub 完成 A Tour of Go 103 页全量重译

图 1:103 个正式课程页面完成最终语义质量审核,结果为 A=103、B/C/D=0,同时不存在缺失、重复或额外页面。A/B/C/D 是本轮项目内部语义质量分级,并不是自动结构 validator 的结果。

(38) 103 页翻完还不能发布:A Tour of Go ChatGPT 译文的语义审核与 Canonical Promotion

图 3:7 个 article endpoint 的 production origin 与 EdgeOne 公网响应全部 exact match,同时新的 ChatGPT 译文标记存在,旧版译文标记已经消失。

(39) 103/103 与 7/7 Exact Match:A Tour of Go ChatGPT 新译文的最终线上验收

【图 2:upstream source preview】

(40) A Tour of Go 多语言翻译项目首次实现 upstream 同步机制:从一次性翻译到长期维护

图 2:A/B/C/D 质量评级规则,展示正式质量 rubric 与 Promotion gate。

(41) A Tour of Go 多语言翻译项目引入 Translation Quality Review:从自动验证到 AI 翻译质量控制

图 4:翻译后 Playground Example,展示中文注释与保持不变的 Go 代码结构。

(42) A Tour of Go 多语言翻译项目实现 Playground Example 本地化:从代码注释翻译到完整学习体验

图 5:公网页面验证广告脚本输出

(43) A Tour of Go 多语言翻译项目接入广告系统:从 AdSense 专用配置到通用 HTML 注入架构

图 3:百度统计单页应用设置

(44) go-dev 单页网站接入统计与 Google AdSense Auto Ads 验证记录

图 1:GitHub 仓库中的多语言翻译项目结构

(45) A Tour of Go 多语言翻译项目:选择日语作为第二语言并启动翻译验证

图 5:模型身份描述不一致

(46) A Tour of Go 多语言翻译项目中的 AI 协作异常排查:一次长期工程会话失效分析

【图 1:ChatGPT GitHub 写入流程调整说明截图】

(47) go-tour-i18n 翻译流程调整:从 ChatGPT GitHub 写入到本地 artifact 导入

图 4 展示了本次异常状态。

(48) go-tour-i18n 翻译自动化流程复盘:已验证的 ChatGPT 翻译能力在新任务中的稳定性问题

【图 6:全部评审结束以后才读取 secret key,完成最终揭盲】

(49) A Tour of Go 翻译质量再评估:Codex High 已接近 ChatGPT High,我决定调整默认翻译引擎

图 4:ja-JP 生产课程页实际运行 Go 示例

(50) A Tour of Go 日语版正式上线:第二门语言 ja-JP 完成生产发布

图 1:ja-JP 上线以后,先提交“新增语言标准化流程”

(51) A Tour of Go 多语言扩展复盘:为第三门语言建立标准化流程

图 1:课程正文结束以后,页面左侧仍然存在大块视觉空白,但 AdSense 并没有在这里插入展示广告。

(52) A Tour of Go 明明有大片空白,为什么 AdSense 就是不显示展示广告?

图 2:golang/website 当前的 _content/tour/。课程内容、静态资源和模板都在这个上游目录中持续维护。

(53) 为了 AdSense,要不要放弃 SPA?A Tour of Go 页面架构的一次取舍

图 4:最终的手动课程广告真实展示在课程内容区域内,而不是 footer 之后。

(54) 保留 SPA 以后,广告应该放在哪里?从 AdSense 预览到方案 B

图 1:Google Search Console 中,多个不同的 A Tour of Go 课程 URL 被判断为“重复网页,用户未选定规范网页”。

(55) SPA 的 SEO 老问题:为什么最后还是给 103 个 A Tour of Go 课程页生成了 Prerender HTML

图 2:方案 B 生产环境中,源码已经正常,但课程主体高度异常缩短,footer 提前进入第一屏。

(56) 从源码空白到 AdSense 高度污染:A Tour of Go 方案 B 的生产收尾

图 1:A Tour of Go 德语版 de-DE 已正式运行在生产环境

(57) A Tour of Go de-DE 上线复盘:第三门语言用了约 16 小时,下一门如何压到 8 小时?

图 1:fr-FR 首次 production 验收完成后,我没有立即开始 ko-KR,而是先连续完成新增语言与首次生产流程的优化

(58) 法语版上线后,我没有马上开始韩语:A Tour of Go 新增语言流程的一轮完善与简化

图 1:根据 ko-KR 期间 76 次 Git 提交估算实际工作时间

(59) 原本预计 6 小时,最后用了约 16~18 小时:A Tour of Go 韩语版上线复盘

图 2:英文 source 与当时发生 validation failure 的 ko-KR candidate 对比

(60) Validator 报错,到底该改译文还是改规则?一次 A Tour of Go 韩语翻译实战

图 2:法语 A Tour of Go 仓库目前已经归档,页面仍保留 553 Commits 和 61 Contributors 的历史

(61) 从法语 553 次提交到韩语两代离线:A Tour of Go 社区翻译为什么难以长期维护

【图 4:es-ES 首次 Production 收口后连续完成的流程优化 commit】

(62) 从 es-ES 首次上线复盘:我把 A Tour of Go 新增语言的 Production 流程又收敛了一轮

图 1:旧公网验收链路连续出现 curl 28 超时,最终导致 public-machine 阶段失败

(63) A Tour of Go Production 公网验收踩坑:从跨境 SOCKS 链路改为 zgocloud direct

图 1:两次 Production Machine Acceptance 都已经通过,但 Headless Chrome 分别在 / 和 /tour/ 判定页面没有完成渲染

(64) 页面明明能打开,为什么 Headless Chrome 仍然判定 Production 失败?

图 3:Bing 从 Google Search Console 中识别到新的 it-IT 站点,并同时发现已有的 1 个 sitemap

(65) GSC → Bing Webmaster Tools:多语言站点如何减少重复验证

图 3:英文站 3 小时内出现 565 个 Cloudflare 来源 URL

(66) IndexNow 实战:手工提交长期不显示,Cloudflare Crawler Hints 却很快出现在 Bing Webmaster Tools

【图 1:A Tour of Go 项目首页目前的语言版本列表】

(67) 从 nl-NL 到 tr-TR:A Tour of Go 连续上线三门语言后,我又优化了哪些流程

【图 4:Go local 页面中已经出现 French、German、Korean、Simplified Chinese】

(68) 从邮件无人回复到进入 Go 官方 Go local:我的 4 个 A Tour of Go 翻译站终于被收录

图8:最终只保留一把启用的新 API Key

(69) 腾讯云 EdgeOne API 自动化:从 CAM 子用户到最小权限 API Key 的完整配置

【图 7:Production Release Batch 最终汇总】

(70) 从同步 Go 官方上游到一个命令发布 10 个语言站:A Tour of Go Production 流程的再次收敛

【图 3:Cloudflare Smart Tiered Cache 已启用】

(71) Cloudflare 缓存 HIT 很快,MISS 却不稳定:回源阿里云杭州的一次真实优化

【图 3:简体中文站 Support 页面】

(72) 广告之外,社区项目如何长期活下去?我给 A Tour of Go 多语言项目加了 Support

图5:评论成功发布

(73) 从 Go Weekly 到 Reddit、DEV 和 Go Forum:第一次系统推广 A Tour of Go 多语言项目

【图 4:RTL 桌面课程布局修复后的效果】

(74) 第一次把 A Tour of Go 做成 RTL:阿拉伯语版本上线,以及我踩过的几个坑

多语言项目应该先做哪些语言?我的 66 个语言版本商业优先级排序

(75) 多语言项目应该先做哪些语言?我的 66 个语言版本商业优先级排序

当术语一致性遇到性能瓶颈:Go 多语言翻译项目的一次架构取舍

(76) 当术语一致性遇到性能瓶颈:Go 多语言翻译项目的一次架构取舍

从 A Tour of Go 走向 Go Learning & Documentation:为什么这个多语言项目需要 v2

(77) 从 A Tour of Go 走向 Go Learning & Documentation:为什么这个多语言项目需要 v2

Markdown 明明可以拆成很多段,为什么 v2 仍然坚持一个 Page 就是一个 TranslationUnit

(78) Markdown 明明可以拆成很多段,为什么 v2 仍然坚持一个 Page 就是一个 TranslationUnit

Tour、Learn、Docs 为什么不应该各维护一份术语表:v2 的统一 Glossary 设计

(79) Tour、Learn、Docs 为什么不应该各维护一份术语表:v2 的统一 Glossary 设计

v2 术语表变更后的页面影响范围判断流程:区分 Compatible 与 Affected,只处理真正受影响的页面。

(80) 术语表改了,为什么不应该让所有页面重新翻译?v2 的影响范围判断

CLI 性能优化示意图:通过 Prepare Once、Reuse Many Times,将执行时间从 6m54.554s 降至 10.335s,约提升 40.1 倍。

(81) 从 6 分 54 秒到 10.3 秒:Go 多语言项目一次 CLI 性能优化实战

历史为什么值得保留:复用已经完成的翻译成果,而不是重新做一遍

(82) 历史为什么值得保留:复用已经完成的翻译成果,而不是重新做一遍

历史状态通过 Trusted Checkpoint 建立可信断点,旧记录继续保留用于审计和诊断,后续工作流从当前状态继续向前,不再要求无限重建过去。

(83) 历史应该被保留,而不是被反复重建:v2 为什么最终需要一个“断点”

v2 依赖与失效传播流程图:从内容变化开始,评估依赖关系和真实影响,将结果区分为“仍然有效”和“需要失效”,只让真正受影响的状态重新进入流程。

(84) 一次内容变化,到底应该让哪些状态失效?v2 的依赖与失效传播设计

v2 本地内容覆盖判断流程图:官方英文页面先检查是否已有正式本地覆盖,有覆盖时使用本地 URL,没有覆盖时直接链接 go.dev,并保持本地路径真实 404。

(85) 有英文页面,不代表一定应该有本地页面:v2 如何处理本地内容覆盖、canonical 与真实 404

v2 代码注释完整性审计流程图:从源页面建立代码块清单,分类教学注释、机器语义和无法判断的内容,再与当前译文精确对应,确认 missing、extra 和 protected mutation 均为 0。

(86) 代码块里的注释为什么不能只靠肉眼检查?v2 如何统计并验证代码注释翻译完整性

前面已经写过一篇:

Markdown 不是纯文本:Learn / Docs 为什么需要新的 parser 与结构保护

那篇主要讨论的是一个基础问题:

页面里并不是所有内容都可以直接交给翻译模型。

标题、正文、链接文字可以翻译。

代码关键字、标识符、路径、URL、指令和很多机器语义不能随便改。

代码块里的注释则更特殊。

有些注释只是机器指令,必须保持原样。

有些注释是真正面向学习者解释代码的自然语言,应该翻译。

做到这里以后,看起来问题似乎已经解决了:

能翻译的注释开放出来,不能翻译的代码继续保护。

但后来我发现,这还远远不够。

因为还有一个更难发现的问题:

我们怎么证明,所有本来应该进入翻译流程的代码注释,都真的被找到了?

如果漏掉了一条教学注释,翻译模型根本不会知道它存在。

质量审核者看到的,也可能只是 parser 已经挑出来的内容。

最终页面可以:

  • 结构完全正确;
  • Go 代码可以运行;
  • 所有保护规则全部通过;
  • 已经进入翻译流程的文字质量也很好;

但代码块中仍然悄悄残留一条没有翻译的英文说明。

这篇就整理 v2 后来为什么又增加了一层:

代码注释完整性审计。


“可以翻译代码注释”和“没有漏掉代码注释”是两个问题

这两个问题非常容易混在一起。

第一个问题是:

某一条代码注释能不能翻译?

例如:

Go
// Print the result.
fmt.Println(result)

这里的:

Plaintext
Print the result.

明显是在向学习者解释代码。

这种内容可以作为教学注释进入翻译。

但下面这种:

Go
//go:generate tool

不是普通自然语言说明。

它属于 Go 指令,不能因为目标语言是中文,就把里面的内容翻译掉。

所以 parser 首先需要做的是分类:

Plaintext
教学性自然语言注释 → 可以翻译
机器语义注释 → 必须保护
未知或无法可靠判断 → 不猜

这一部分解决的是:

翻译边界。

但第二个问题完全不同:

源页面里到底一共有多少条应该翻译的教学注释?

如果 parser 本来应该发现 20 条,却只发现了 19 条,那么后续流程无论做得多严格,都无法发现那第 20 条没有进入翻译。

所以:

“已经发现的注释都处理正确”并不能证明“所有注释都已经被发现”。


最危险的遗漏,往往不会报错

这种问题之所以值得单独做完整性检查,是因为它经常不会造成明显故障。

假设一个页面里有:

Go
func main() {
    // Calculate the total.
    total := a + b

    // Print the result.
    fmt.Println(total)
}

如果 parser 只识别到了第二条:

Plaintext
Print the result.

那么生成出来的中文页面可能变成:

Go
func main() {
    // Calculate the total.
    total := a + b

    // 打印结果。
    fmt.Println(total)
}

代码完全合法。

页面也能正常渲染。

机器结构校验可能全部通过。

审核者如果主要看翻译候选,也可能不会意识到:

第一条注释其实从来没有进入过翻译流程。

这就是我现在觉得最需要警惕的一种错误:

静默遗漏。

它不像语法错误那样会立即失败。

反而很容易一路跟着内容进入生产环境。


只检查目标译文是不够的

一开始很容易想到一种检查方式:

扫描中文页面,看看代码块里还有没有英文。

但这个办法并不可靠。

因为代码本身本来就会包含大量英文。

例如:

Go
func GetAlbumByID(id string) (*Album, error) {

里面的:

  • GetAlbumByID
  • id
  • string
  • Album
  • error

都应该保持原样。

API 名称、字段名、包名、文件名、JSON 字段、操作系统名称等,也可能合法保留英文。

所以不能简单做:

Plaintext
目标页面还有英文 → 一定漏译

同样,也不能认为:

Plaintext
目标页面没有明显英文 → 一定完整

真正可靠的判断必须从源内容开始。


第一步不是检查译文,而是建立唯一的源注释清单

v2 后来采用的思路是:

先从规范源内容建立完整的代码注释清单,再拿目标语言结果与它比较。

这个顺序非常重要。

源内容负责回答:

页面里到底有哪些代码块?

哪些代码块真正包含注释?

哪些注释属于教学自然语言?

哪些属于机器语义?

哪些代码块当前还无法安全判断?

只有先把这一层证明完整,后面的“有没有漏译”才有意义。

项目现在专门提供了代码注释审计入口,例如:

Plaintext
tour-i18n code-comments unsupported --output-dir /tmp
tour-i18n code-comments coverage --output-dir /tmp
tour-i18n code-comments audit --output-dir /tmp

这些命令本身属于只读工程审计。

它们可以输出诊断 JSON 和文本证据,但不会修改:

  • 候选译文;
  • Candidate Snapshot;
  • 质量审核;
  • authorization;
  • 内容包封存;
  • 整合站点状态;
  • activation。

也就是说:

先证明问题,再决定是否需要进入正式修订流程。

而不是扫描到什么,就立即开始改内容。


为什么不能直接搜索 //

如果只是 Go 代码,看起来似乎可以用很简单的办法:

Plaintext
搜索 //

然后把后面的内容都统计出来。

但这个办法很快就会出问题。

例如字符串里可能有:

Go
url := "https://go.dev/doc/"

这里的:

Plaintext
//

当然不是注释。

同样,页面里还可能出现:

  • JSON;
  • go.mod;
  • 命令行;
  • 终端输出;
  • SQL;
  • HTML <pre>;
  • 文档里的路径示例;
  • 普通纯文本代码块。

不同语言对注释的定义完全不同。

例如:

Plaintext
#

在某些语言里可能是注释。

但在 shell 参数、URL fragment、普通输出或文本示例里,它又不一定代表注释。

所以完整性检查不能依赖:

“看到某个符号,就猜它是注释。”

而必须依赖:

已经证明的源语言和完整语法。


语言本身也不能靠文件路径猜

另一个很容易出现的捷径是:

这个页面在 Go 教程里,所以代码块应该都是 Go。

或者:

里面出现了 //,所以应该是 Go。

这同样不可靠。

v2 当前使用的原则更保守。

判断代码块语言时,优先使用:

  • Markdown fence 明确声明的语言;
  • HTML 中明确的 language-*;
  • 已有 source parser 或 metadata 的正式语义;
  • 最后才是严格 parser 对整个代码块的完整接受。

不能使用:

  • 目标译文内容;
  • locale;
  • Preview;
  • 文件路径猜测;
  • 某几个 ASCII 关键字;
  • 宽松正则表达式;

来证明源代码语言。

这一点很重要。

因为:

一旦把语言猜错,后面的“没有注释”也可能是假结论。


“没识别到注释”不能自动等于“这里没有注释”

这大概是整个完整性设计里,我最认可的一条原则。

假设遇到一个代码块。

当前 parser 不认识它的语言。

最简单的实现可能会得到:

Plaintext
发现注释数 = 0

但这个 0 到底代表什么?

可能代表:

parser 完整理解了这段代码,并证明其中确实没有注释。

也可能只是:

parser 根本不知道该怎么分析。

这两个状态完全不同。

所以 v2 不允许把:

无法分析

偷偷变成:

已经证明没有注释

未知语言必须明确保留成“不支持”或“存在歧义”。

只要仍然存在无法证明的代码块,就不能声称:

代码注释覆盖已经完整。

这和整个项目一直采用的原则是一致的:

无法证明时,按失败处理,不猜。


每一个代码块都必须得到明确结论

为了避免代码块在统计过程中悄悄消失,v2 会给每一个原始代码块一个明确状态。

可以大致理解成下面几类。

已经提取注释

说明语言受支持,而且已经建立了精确的注释槽位。

通过完整语法证明没有注释

不是“没搜到”,而是 parser 已经证明其中没有注释。

终端会话记录

明确区分命令和输出,不能再把输出中的 #、// 或 -- 当成程序注释。

非代码输出或字面量

源内容本身已经证明这是输出、数据或文字示例,而不是需要继续分析的程序源码。

机器语义整体保护

内容明确属于机器语义,整块保持不变。

存在歧义、暂不支持

无法可靠确定,就明确留下未解决状态。

这里最重要的不是分类名字本身。

而是:

每一个原始代码块必须出现,而且只能得到一个结论。

不能:

  • 丢块;
  • 多出块;
  • 改变顺序;
  • 用目标译文重新猜类型;
  • 把未知块默认为零注释。

统计的重点不是只有“注释总数”

如果真要避免遗漏,只统计:

Plaintext
一共有多少条注释

仍然不够。

更有价值的统计应该同时包括:

  • 一共有多少代码块;
  • 多少代码块成功提取注释;
  • 多少通过语法证明没有注释;
  • 多少属于终端记录;
  • 多少属于输出或字面量;
  • 多少属于机器语义;
  • 多少仍然无法可靠分类;
  • 每种源语言分别有多少代码块;
  • 一共有多少教学注释;
  • 目标译文中多少注释仍然与源内容完全相同;
  • 是否存在缺失注释;
  • 是否存在额外注释;
  • 是否存在代码结构或受保护内容变化。

这样统计才真正回答:

整个 source coverage 是不是完整的?

而不是只给出一个看起来很漂亮的数字。


注释身份不能只依赖行号

还有一个容易被忽略的问题:

怎样确认源注释和目标译文中的注释是同一条?

如果只使用行号,会很脆弱。

Markdown 页面里只要前面增加几行内容,后面的所有行号都会变化。

所以 v2 的注释身份会绑定更稳定的上下文,例如:

  • 内容包;
  • source path;
  • parent kind / ID;
  • parser block coordinate;
  • comment ordinal;
  • 前一个词法 token 的位置;
  • source semantic kind。

这里的目标不是:

给每条注释做一个永远不变的身份证。

因为源代码真正发生语义变化以后,对应关系本来就可能需要重新建立。

真正需要的是:

在当前这份规范源内容里,能够精确证明这条注释是谁。


Source 变化以后,旧统计也不能自动继续用

这和前面写过的失效传播问题其实又连起来了。

假设昨天完成了:

Plaintext
代码块数量 = X
教学注释数量 = Y
未知代码块 = 0

今天规范源内容发生了变化。

那么不能简单认为:

昨天已经统计过了,所以今天继续用。

因为源内容或者代码结构变化以后:

  • 可能新增代码块;
  • 可能新增注释;
  • 可能删除注释;
  • 可能改变注释所在结构;
  • 可能让旧的对应关系失效。

所以 source inventory 也有自己的当前性。

统计结果只有绑定当前源内容时才有意义。


对目标语言的检查,必须使用当前正式译文

建立完整源清单以后,下一步才是比较目标语言。

这里也不能随便从某个旧目录读取文件。

因为项目里可能同时存在:

  • 历史 Snapshot;
  • 旧 candidate;
  • 已经失效的 promotion;
  • 当前正式 candidate;
  • Preview 中的渲染结果。

真正的代码注释完整性检查必须读取:

已经由当前正式 authority 证明的目标内容。

如果无法证明某份目标译文仍然是当前版本,就应该明确输出:

Plaintext
CURRENT_TARGET_UNAVAILABLE

而不是:

“这里刚好有一个文件,就先拿它比较。”

这也是为什么完整性审计和历史恢复不能混在一起。


对中文来说,教学注释完全没变化,本身就是一个强烈信号

假设英文源注释是:

Go
// Return the vulnerability ID.

中文目标页面里仍然是:

Go
// Return the vulnerability ID.

如果这条注释已经被正式分类为:

teaching-comment

那么对于中文这种非英语目标语言来说:

完全保留英文源文本,本身就应该被机器视为失败。

因为这时候已经不需要 Reviewer 来判断:

“这句话是不是漏翻了?”

机器已经知道:

  1. 它是可翻译的教学自然语言;
  2. 当前 locale 不是英语;
  3. 目标文本与源文本完全相同。

因此可以确定:

这条教学注释没有真正进入目标语言。

而对于英语变体,例如 en-GB、en-CA,这种 exact carry 又可能完全合理。

所以这里还需要知道目标 locale 的基础语言,而不是简单维护一张“哪些 locale 是英文”的手写名单。


但“文字不同”也不能证明翻译正确

反过来也一样。

如果:

Plaintext
source comment ≠ target comment

只能证明:

两边字节不完全相同。

它不能证明:

翻译质量正确。

例如原文:

Plaintext
Return the vulnerability ID.

目标内容被改成一句完全错误的中文。

机器只能确认:

它不是原样照搬英文了。

但自然度、准确性和术语仍然需要独立 Reviewer 判断。

所以这里的职责边界很清楚:

机器负责证明完整性和结构对应。

Reviewer 负责判断语言质量。


“有没有漏译”不应该先交给 Reviewer 猜

这一点我觉得特别重要。

如果机器已经能够确定:

  • source 有一条教学注释;
  • target 对应位置不存在;
  • target 多出一条无法对应的注释;
  • 受保护内容发生变化;
  • 代码块结构不一致;

这些都不应该先拿给 Reviewer 问:

“你觉得是不是漏译了?”

因为这是确定性的结构事实。

Reviewer 更应该把时间花在:

  • 翻译是否准确;
  • 表达是否自然;
  • 术语是否合适;
  • 教学意图是否保留;

这些真正需要语言判断的地方。

所以:

能由机器确定的问题,就不要消耗人工语言审核。


完整性失败也不应该让整个内容包全部重做

如果统计发现:

49 个页面里只有 3 个页面存在教学注释遗漏。

最简单的做法仍然是:

Plaintext
整个内容包重新生成
→ 所有页面重新审核

但这又回到了前面几篇一直在避免的问题。

更合理的是:

Plaintext
确定受影响页面
→ 只重新打开这些页面
→ 精确修订遗漏的注释
→ 重新执行机器校验
→ 独立复审
→ 建立新的后继正式状态

其他已经证明:

  • source 没变化;
  • 注释完整;
  • candidate 当前有效;
  • 之前 A 仍然可信;

的页面继续继承。

所以代码注释完整性最终也接入了同一套:

affected-only

思路。

不是再造一套特殊工作流。


这也解释了为什么内部 comment slot 不能变成新的正式翻译单元

为了统计注释,内部一定会生成非常细的记录。

例如:

Plaintext
Page
→ Code Block 3
→ Comment 2
→ teaching-comment

但这并不意味着应该把每一条 comment 都变成正式 TranslationUnit。

正式治理边界仍然是:

一个物理 Page,就是一个正式 Page TranslationUnit。

内部 comment slot 的作用是:

  • parser;
  • 保护;
  • 还原;
  • 校验;
  • 完整性审计;
  • 精确影响分析。

它们是为了让机器看得更细。

而不是为了把正式审核流程切得越来越碎。

这和前面“Page 是治理单位,slot 是内部解析单位”的设计仍然保持一致。


未来的新内容,也可以先做源侧预检

这套统计还有一个我很喜欢的用途:

内容还没有正式进入 TranslationUnit 生命周期之前,就可以先检查代码注释覆盖风险。

例如未来准备纳入更多 /doc/ 页面。

可以先从冻结的官方 source 做只读分析:

  • 有多少代码块;
  • 哪些语言已经支持;
  • 是否存在未知语法;
  • 是否存在无法分类的注释;
  • 当前 parser 是否已经能够完整覆盖。

如果 source 阶段就发现:

有大量 ambiguous code block

那么完全可以先修 parser。

而不是等内容正式进入 Generation 以后,才发现:

原来还有一批代码注释根本没有被识别。

这其实是在把问题尽量提前。


好的完整性检查,应该能够证明“零遗漏”,而不是报告“看起来没问题”

我觉得这篇最核心的区别就在这里。

最弱的检查方式是:

我扫了一遍,好像没有英文注释。

稍微强一点的是:

已经识别的所有 teaching comment 都有目标文本。

而真正希望达到的是:

Plaintext
所有原始代码块都已建立 disposition
→ 不存在 ambiguous unsupported
→ 所有 source teaching comment 都有精确身份
→ 所有 current target comment 都能精确对应
→ 不存在 missing
→ 不存在 extra
→ 不存在 protected mutation
→ 不存在 structure mismatch

到了这里以后,才能更有底气地说:

当前支持范围内,没有已知代码注释遗漏。

注意,这句话里最重要的其实是:

当前支持范围内。

如果还有未知 grammar,就必须明确说:

目前仍然是 partial coverage。

不能因为已识别部分全部通过,就把未知部分一起算成 PASS。


这和普通翻译质量审核解决的是两个不同问题

做到这里以后,我觉得可以把整个问题分成两条线。

第一条是质量:

已经进入翻译流程的文字,翻译得好不好?

第二条是完整性:

所有应该进入翻译流程的文字,有没有真的全部进入?

第一条主要依赖 Independent Reviewer。

第二条则更依赖:

  • source inventory;
  • parser;
  • 精确对应;
  • currentness;
  • deterministic validation。

如果只做第一条,就可能得到:

每一句已审核译文都很好。

但仍然有内容从来没有进入审核。

所以:

翻译质量高,不自动等于翻译完整。


这次设计让我重新理解了“统计”的意义

以前提到统计,很容易想到:

Plaintext
有多少页面
有多少注释
有多少已经翻译

后来我越来越觉得:

统计不是为了做报表,而是为了建立完整性证明。

真正有价值的统计不是一个总数。

而是能够回答:

总数是怎么来的?

是否覆盖了全部 source block?

哪些被证明没有注释?

哪些仍然未知?

哪些目标内容缺失?

哪些只是机器语义而不应该翻译?

如果这些问题回答不了,那么:

Plaintext
translated_comments = 100%

这样的数字本身并没有太大意义。


最终形成的几条原则

现在回头看,代码注释完整性这部分可以浓缩成几条规则。

第一:

“能够翻译教学注释”不等于“没有遗漏教学注释”。

第二:

完整性检查必须从规范源内容建立唯一 inventory,不能从目标译文反推。

第三:

不能靠 //、#、文件路径或几个关键字猜测代码语言和注释边界。

第四:

unsupported 不等于零注释;无法证明时必须明确保留未知状态。

第五:

每一个原始代码块都必须得到唯一、可追溯的处理结论。

第六:

机器负责 missing、extra、结构和受保护内容完整性;Reviewer 负责翻译质量。

第七:

目标比较只能使用当前正式译文,不能因为历史文件存在就自动复用。

第八:

完整性失败只重新打开真正受影响的 Page 或 Example,不让无关的 A 全部重做。

最终目标并不是:

尽可能找出一些代码注释来翻译。

而是:

能够证明所有应该进入翻译流程的代码注释,都没有被静默遗漏。

有英文页面,不代表一定应该有本地页面:v2 如何处理本地内容覆盖、canonical 与真实 404

Go 学习与文档多语言本地化项目

本系列完整记录 Go 学习与文档多语言本地化项目从 A Tour of Go 起步,逐步扩展到站点首页、项目说明页、学习内容、文档以及未来内容包的实际开发过程,包括架构设计、统一术语治理、整页翻译、结构保护、自动校验、独立质量审核、生产发布与长期维护。

项目源码:
✅ GitHub:shuijingwan/go-tour-i18n

语言版本:

当前跨项目目标语言池共包含 66 个语言版本。Go 项目本身目前提供 65 个社区 Production 语言版本,下面每一门 Go 语言版本都直接链接到其当前公开站点。语言列表沿用项目首页现有的展示顺序。

英语(美国)仅作为跨项目目标语言纳入列表,并不是单独的 Go Production 语言版本。当前 Go 的英文源内容仍为官方 generic English,因此英语(美国)链接到 Go 官方站点,而不是不存在的本地社区部署。

  1. 阿姆哈拉语
  2. 阿拉伯语
  3. 孟加拉语
  4. 葡萄牙语(巴西)
  5. 保加利亚语
  6. 加泰罗尼亚语
  7. 克罗地亚语
  8. 捷克语
  9. 丹麦语
  10. 荷兰语
  11. 英语(美国)(Go 官方英文站点)
  12. 英语(澳大利亚)
  13. 英语(加拿大)
  14. 英语(印度)
  15. 英语(新加坡)
  16. 英语(南非)
  17. 英语(英国)
  18. 爱沙尼亚语
  19. 菲律宾语
  20. 芬兰语
  21. 法语(法国)
  22. 法语(加拿大)
  23. 德语(德国)
  24. 德语(奥地利)
  25. 德语(瑞士)
  26. 希腊语
  27. 古吉拉特语
  28. 希伯来语
  29. 印地语
  30. 匈牙利语
  31. 印度尼西亚语
  32. 意大利语
  33. 日语
  34. 卡纳达语
  35. 哈萨克语
  36. 韩语
  37. 西班牙语(拉丁美洲)
  38. 拉脱维亚语
  39. 立陶宛语
  40. 马来语
  41. 马拉雅拉姆语
  42. 马拉地语
  43. 书面挪威语(Bokmål)
  44. 波斯语
  45. 波兰语
  46. 葡萄牙语(葡萄牙)
  47. 旁遮普语(果鲁穆奇文,印度)
  48. 罗马尼亚语
  49. 俄语
  50. 塞尔维亚语(西里尔文)
  51. 简体中文(中国大陆)
  52. 简体中文(新加坡)
  53. 斯洛伐克语
  54. 斯洛文尼亚语
  55. 西班牙语(西班牙)
  56. 斯瓦希里语(坦桑尼亚)
  57. 瑞典语
  58. 泰米尔语
  59. 泰卢固语
  60. 泰语
  61. 繁体中文(台湾)
  62. 繁体中文(香港)
  63. 土耳其语
  64. 乌克兰语
  65. 乌尔都语
  66. 越南语

项目正在持续扩展新的 Go 学习与文档内容,并长期维护各语言版本的术语一致性、翻译质量、独立审核、生产发布与后续更新。

本项目属于非官方社区多语言本地化项目,与 Go 官方无隶属、授权或背书关系。