团队开发代码不爱写注释，如何解决这一困境？

[labulaka521]

刚入职不久，维护的心累，在别人的没有注释代码上加功能是真的难受

怎么让大家对于比较复杂的逻辑习惯写上注释

[boris93]

我司，跨国美企，也这样
更不用说还能见到各种匪夷所思的脱裤子放屁写法
非英语国家的人写的注释，有可能还得琢磨一阵才能看明白

对我来说，业务清晰（至少在我自己看来清晰）的代码我不写注释
对于日后可能看不懂的，或者当时就玩命网上冲浪才憋出来的代码，我会写很多的注释，并且可能附上参考文档链接

[raaaaaar]

找 leader ？拿个垃圾代码过去问他看不看得懂，引导他自己提出规范的重要性。

[ferock]

自己判断，代码是否可读
技术方案文档，另外写
代码上附上链接。

代码定期内部 code review 。
别人如果看不懂你的代码，那就应该附上注释，最好重构。

所以，团队合作写代码，规范很重要！

[AkideLiu]

换 assembly 吧，今天不写注释明天就看不懂了

[line]

大部分情况，可以用 git commit message 代替 commit 勤快点就行

[user8341]

刚入职不久就别妄想去改变公司既有的习惯。好好适应一年。

[kemikemian]

你待的时间久了自然也不写了,还没融入集体

[djs]

良好的命名比瞎写的注释更优秀，前提是良好的命名

[nicevar]

可以搭建 SonarQube 平台，提交 MR 的时候没有注释会自动拒绝

[jerryrib]

[sexyback]

我找了个实习的工作，go 开发，原本想来学一下 go，结果这几天看了代码之后发现一句注释也没有，唯一的注释就是 //TO DO 这个功能尚未开发，问了带我的导师他说写注释太麻烦，看变量命名和方法名就能推算出什么意思了，学习的时候不知道注释的重要，现在终于体会到了

[sexyback]

@labulaka521 咱俩估计一样，我们公司的代码就没有注释

[labulaka521]

@djs 确实是
但是我们这边存在的情况是有些被重构的函数 迁移的字段 但是为了兼容还是保留原有的 这些几乎都没有注释 有些时候的用老的函数 老的字段偶尔就会出现异常

[labulaka521]

@sexyback 其实 go 还好 但是我们这边是 py 吗呀 函数参数一大堆 几乎没有注释 只有追到函数内部后才可以看到这个参数的类型 是干啥的

[xianxiaobo]

你来当老板或者领导，告诉大家注释最重要，可以开发的慢，但是一定要写注释，每天快下班前由技术领导统一检查今天的代码写注释了没。

[labulaka521]

@xianxiaobo 想认真回复就认真回复 别这样阴阳怪气的 OK ？没看前面的吗？

[jorneyr]

把自己写的代码也像 JS minify 那样搞一下，大家一起看不懂

[Leigg]

这个没办法，以后你会经常遇到，除非老大提出来解决，否则都是看个人心情，你现在不懂哪里就问，不过最后先看完整体逻辑，再提问，自己写好注释

[xiaoxinxiaobai]

你读一遍代码给加上注释

[notejava]

可读性强的代码就是最好的注释。如果代码本身就逻辑混乱，也别指望注释了。