作为一名程序猿最讨厌做的事是什么?
产品经理频繁修改需求?不是。
测试天天给你提交不可理喻的 bug ?也不是。
接手别人交接的如火星文一样的烂代码?还不是。
▼
程序员最讨厌的四件事：
写注释、写文档、别人不写注释、别人不写文档。
不错，今天我们就来谈谈程序员最讨厌做的这件事：
写注释!
程序员该不该写注释?
其实对于写注释这件事来说，还是有一定的争议的，争议其实不在于该不该写注释，而是在于不要过多的写注释，注释多了，反而会让你感觉整个代码比较混乱不堪，影响视觉。
而且为什么不太鼓励大家过多的去写注释呢?因为代码即注释
何为代码即注释?代码是具有自解释功能的，高质量，命名规范的代码，其实程序员应该一眼就能够看懂这段代码的功能作用是什么?
所以，程序员到底该不该写注释?
事实证明：该，但是要注意分寸。
1.优秀的程序员可以少写注释~
优秀的程序员都是懒的。因为懒，他才会写出各种各样的工具来替自己干活。因为懒，他才会想办法避免去写无聊重复的代码——因此避免的代码的冗余，削减了代码的维护成本，使重构变得更加容易。
代码即注释。作为一个优秀的程序员，大多数都懂得注释不是用来翻译程序代码的，用代码能说清楚的东西，就自然不用费脑子去写注释了，集中精力写出最优雅、高质量的代码才是首要的。本身对于简短的代码，规范的命名、条理清晰的书写方式，让人一看就懂，那么本身这个代码就不需要注释，它自身就具有自解释功能。
当然，如果一个函数上百行代码，甚至更多，还是需要写一定的注释的，甚至在一个重要的业务逻辑处理的地方，还是需要注明一些注释的，毕竟时间久了，业务逻辑不熟悉了，看代码确实有些费劲。
2.初级中等程序员还是得写注释~
作为一个入门，初级或者中等的程序员，在自己代码质量不高的阶段，时刻提醒自己养成一个好的写注释的习惯还是很有必要的。
为什么很多程序员不愿意接手别人写的代码，是因为有一个问题就是必然存在的。每个人的编码风格不一样，命名方式和规范不一样，加上由于程序员代码的个性化，就造就了代码的多样性。倘若再没有注释，谁还愿意看?所以，前期记住一定得写注释。
记住：与人方便就是与己方便。
为什么谈这个话题?
对，为什么谈这个话题呢？因为有很多程序员写代码总有一种非常非常不好的习惯，那就是一段代码不用了，注释掉，但是他心里还总想着感觉这段代码以后可能还会用。所以就留着，不删掉，但大多数情况下，过几天就忘了，结果代码里到处都是注释，没有一句是有用的。
接下来好了，接手的读代码的人也不敢删，一直留着，留着，留着，留着……直到永远。
你们大声告诉我，你们是不是有这种习惯？是不是有这种心理？
注释维护
我想说，注释也是需要维护的。很多人都没有意识到注释维护的重要性。怎么说呢？不写注释坑人，比不写注释更坑人的就是写了注释，功能变了，不修改注释的人。
比如：
今天是程序员小王写了一个处理业务逻辑的功能方法，功能是炒菜。过了两个月后，需求变了，人家客户不喜欢吃炒菜，需要换成了煮菜了。这时程序员小陈就在炒菜的功能方法上直接修改了，把功能改成了煮菜。但是注释上写的还是炒菜。又过了两个月，客户需求又变了，客户吃腻了煮的菜，要求改成蒸饭。
这时项目经理说：小郭，你把那个煮菜功能给我换成蒸饭。这时，程序员小郭，找啊找，找遍了注释，发现没有煮菜功能，一气之下，算了，自己写吧，自己又写了一个蒸饭的功能函数。之后带有炒菜注释的煮菜功能，在接下来的一个又一个程序员都不敢删，也不管了。
看到了，注释不维护，是不是很不好。这只是其中一个方法，如果你修改了大部分的方法，又没有修改注释，接下来接手的程序员又不敢乱动，还看不懂，自己又重新写，代码冗余，混乱不堪，之后越来越烂，代码越来越没人管了，也不想干了。
呕出一口老血!
总结
代码即注释，写注释要注意分寸。如下：
► 用高质量的代码代替注释。
► 在复杂函数和重要的业务逻辑面试，还是必须要写注释的。
► 注释需要维护，不是写了就好。不维护，还不如不写。
►要学会命名，遵守规范，这样才能够培养出好习惯。
最后
感谢大家能耐着性子，看完这篇文章。
在这里我也分享一份自己收录整理的Android学习PDF+架构视频+面试文档+源码笔记，还有高级架构技术进阶脑图、Android开发面试专题资料，高级进阶架构资料帮助大家学习提升进阶，也节省大家在网上搜索资料的时间来学习，也可以分享给身边好友一起学习
如果你有需要的话，可以点赞+转发，关注我，然后关注微信公众号【Android开发之家】免费领取
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
