给代码注释做翻译，这是一项技术工作，它看上去蛮简单，可实际上到处都是细节，并且还存在争议。它根本不是那种简简单单的文字之间的转换，而是一座特别重要的桥梁，这座桥能干啥呢？它能把不同语言的开发者连接起来，还能维护代码的可读性，更能推动知识的传递。这项工作会直接对团队协作效率产生影响，对项目长期的可维护性也会产生影响。
为什么要翻译代码注释
首要目的是，降低非母语开发者理解门槛的，是翻译代码注释。当一个国际团队协作，或者开源项目希望吸引全球贡献者时，母语注释能够极大提升他们参与感和效率。其次，它有助于知识留存。在核心开发者变动时，清晰的母语注释能成为宝贵项目文档，让后续维护者更快理解代码意图以及设计思路。
可是呢，翻译工作是需要对此成本与收益进行权衡考量的。并不是所有的注释都是值得加以翻译的，比如说那些用来描述明显可见逻辑情况的简单注释。要优先对那些能够解释复杂算法、业务规则、并且阐述历史决策引发原因，还有潜在陷阱方面情况阐释的关键注释进行翻译，这样才能够使得翻译投入以及其产出达到最大化的效果。
如何准确翻译技术术语
对技术术语进行翻译，这属于注释翻译里核心的难点所在。在处理的时候，应当遵循业界通用的译法，就像把“buffer”翻译成“缓冲区”，将“recursion”译为“递归”这样。对于那些没有标准译法或者容易产生歧义的术语而言，有一个实用的方法，那就是保留英文原词，并且在它后面用括号补充简短解释。如此一来，既能够保证专业性，与此同时又避免了因为生造译名而造成的误解。
还有一种情形是公司内部或者项目所属范畴里那些特定的专门用语。这类特殊用语的翻译务必要跟团队内部现已存在的中文文档、需求说明文件保持一样的做法。打造并维续一个团队内部涵盖术语对应关系的表单相当关键，这能够保证在翻译的时候维持统一，防止同一个概念于代码的不同地方呈现出多种翻译。
机器翻译与人工审校如何结合
当下，机器翻译引擎，像DeepL、GPT这些，于处理技术注释方面已然有了颇为不错的表现，能够极大程度地提升初次翻译的效率。然而，完全依靠机器翻译是存在风险的，原因在于它有可能对代码上下文造成误解，进而产出看似语句通顺但实际上却是错误的或者歪曲了原意的译文。举例来说，它或许会在特定上下文里将“server”（服务器）跟“waiter”（服务员）的指代弄混淆。
合理的流程为“机器翻译加上人工审校”，开发者或者专业译员凭借机器翻译来生成初稿，之后依据对代码逻辑的深度领会开展审校，审校的关键要点在于核查术语精确程度，改正因语境欠缺致使的误译，还要保证译文风格跟代码其他部分的注释维持一致。
翻译注释时要注意哪些格式问题
代码注释存在着其固有的格式，在进行翻译之时是不能够将其破坏掉的。针对于行内注释（// 或 #），需要留心译文的长度，要防止因为句子过于长而致使折行从而影响到代码漂亮的外观。针对于块注释（/<b> ... </b>/），需要保持好原有的排版结构，像是星号要相互对齐等等，以此来维护代码的整齐清洁性。
得特别留意的是，别去翻译代码里的变量名，还有函数名，以及类名等标识符。对于注释里所引用的这些标识符，一般是保留其原本样子的。同时，所有的链接，就像指向技术文档的URL这类，还有错误信息代码等同样要保持原来模样，以此保证其功能不会受到影响。
哪些注释不应该翻译
存在一些注释并不适宜进行翻译。第一，是那些极为简短、仅仅用于表示状态的注释，像“TODO”、“FIXME”、“BUG”，这些已然成为国际通用的标记了；保留原本样子来更有利于工具识别以及团队共识。第二，是些已经过时、用作述说了，失效逻辑的注释；与其选择翻译它，反倒如直截了当地去更新或者把它给删除掉 。
对具有法律效力的注释，诸如法律声明、版权信息等而言，要是其最初呈英文状态，那么在进行翻译之前务必谨慎从事，在必要之时还需要向法务部门进行咨询。对于那简单的个人署名注释，像“Created by John”这样的，同样不需要予以翻译，保留其原名更能够展现出贡献的历史情况。
如何管理翻译后的注释同步
代码持续处于迭代状态，关于注释翻译所遭遇的最为重大的挑战即为怎么去跟源代码实现同步更新，理想的举措是把翻译之后的注释当作代码库的一部分来开展版本管理，当英文原本的注释被作出修改或者有所添加的时候，应当在同一次的提交或者关联提交当中更新与之相对应的翻译，并且要在提交信息里进行说明 。
对于大型项目而言，能够考虑运用专门的国际化（i18n）工具或者脚本，把注释提取出来放置到外部资源文件当中进行管理。然而这会带来额外的维护成本。更为务实的一种做法是把它归纳进代码审查流程里，要求开发者在对重要注释做出修改之际，同时考量其对于翻译版本所产生的影响句号。
于团队协作期间，你可曾因代码注释所用语言方面的问题，遭遇过沟通上的阻碍或者说出现过理解偏误呢？不妨在评论区去分享你的经历以及看法，倘若觉着本文是有帮助的，那么也请点个赞并且分享给更多的开发者哟！
原创文章，作者：有道翻译，如若转载，请注明出处：https://fanyi-youdao.net/archives/709
