辩论:代码注释,该用中文还是英文?
上周 review 同事的提交,一半注释是中文、一半是英文,两边都有人看不顺眼,办公室里吵了起来。
一方说:代码是给人读的,母语最快,团队里都是中国人,中文注释一眼就能懂。 另一方说:开源项目、技术资料全是英文,注释统一英文,将来公开代码、找资料都不别扭。
争到最后发现,大家真正在意的不是语言,是沟通成本——注释写给谁看、谁来维护?把这个问题摆上台面,想听听你们的立场。
上周 review 同事的提交,一半注释是中文、一半是英文,两边都有人看不顺眼,办公室里吵了起来。
一方说:代码是给人读的,母语最快,团队里都是中国人,中文注释一眼就能懂。 另一方说:开源项目、技术资料全是英文,注释统一英文,将来公开代码、找资料都不别扭。
争到最后发现,大家真正在意的不是语言,是沟通成本——注释写给谁看、谁来维护?把这个问题摆上台面,想听听你们的立场。
注释是写给下一个维护者看的,母语表达最直接。中文注释写得出原因和意图,英文注释常常只剩敷衍的逐行翻译。
代码可能被任何人接手,英文注释是通用语言,搜资料、发开源都无缝。中英混杂反而最难看。