不要排斥中文注释

  项目的代码注释,我们并不限定只能使用英文,对某些对较为复杂算法的解释,用英文会带来理解上的问题,用中文注释更易理解,一般简单易懂的可以用英文,注释最重要的是能够看懂,看不懂,用多国际化的语言都不顶用,代码不只是给自己看的。而且在存在复杂语句的时候,如果英文注释各种语法不通,就更是闹笑话了。

  当然,如果你对自己的英语自信,可以使用全英文,但是请也要考虑代码的后继维护者的语言水平。

  在此只是声明:

  不要排斥中文注释!

  注释的首要原则,是易于理解!

  一种情况下例外,当你开发一个开源项目的时候,还是用全英文吧,得保证全世界所有人都能看懂。

猜你喜欢

转载自blog.csdn.net/rs_lys/article/details/84753199