IT门户, 中国互联网人工智能物联网行业资讯平台--公众IT
新闻来源:互联网资料整理       发布时间:2023/4/5 16:35:23       共计:4618 浏览

代码注释只有一个目的,无外乎就是通过注释说明的方式帮助其他开发人员和未来的自己了解代码逻辑,提高代码可维护性。在我看来,只要注释简洁易懂,采用英文来注释代码不是必须的。但要求采用英文注释代码可能有以下几点原因:

团队成员来自全球多个地区

这个无需做过多解释了,如果团队成员来自全球多个地区,为了能让所有人都能看懂,用英文是唯一的选择了。

避免中文等语言乱码问题

虽然目前有很多比较强大的IDE来帮助开发人员管理工程,但是仍不可避免在一些场景下代码会出现乱码问题。乱码多是由于编辑器对宽字符不支持的缘故,例如,中文字符就是宽字符,可能会有乱码问题。

强迫症

由于历史原因,我们只能够使用英文来写代码,如果注释写中文的话还要切换输入法,有的时候会觉得很麻烦。另外,有强迫症的同学会更加倾向于使用英文来写注释,毕竟注释的时候还能顺便提高英语水平,这个原因可能还占了更大的比例。

结语

编写代码注释还是要注重实效,而不要关注于注释的形式。网上有一些奇葩的注释,比如弄个骆驼造型或者羊驼之类的都是极少数,毕竟大家都忙着写代码,哪里有时间摆造型呀。关于注释使用的语言,从实际效果来看,无所谓。如果要避免以上提到的乱码问题,选择英文更加妥当。


大家的选择是什么呢?是不是也在注释方面有强迫症呢?

这个事情我也碰到过,在windows中文下,代码文件因为是文本文件,默认用的GB编码文件。到了linux下GCC和文本工具认的却是utf8,在windows下的中文注释,拿到linux之后,全是乱码。

其实,除了windows,其他系统几乎都用utf8。

windows下,只有把代码编码保存为utf8才不会出现这种问题。

而当代码文件中的所有字符都是英文时,所有编码在所有系统都是兼容的。

另外,如果你的团队中有其他国籍的人,那么英文注释肯定是必须的。

版权说明:
本网站凡注明“公众IT 原创”的皆为本站原创文章,如需转载请注明出处!
本网转载皆注明出处,遵循行业规范,如发现作品内容版权或其它问题的,请与我们联系处理!
您可以扫描右侧微信二维码联系我们。
网站首页 关于我们 联系我们 合作联系 会员说明 新闻投稿 隐私协议 网站地图