作为一名程序猿最讨厌做的事是什么? 产品经理频繁修改需求?不是。 测试天天给你提交不可理喻的 bug ?也不是。 接手别人交接的如火星文一样的烂代码?还不是。
程序员最讨厌的四件事: 写注释、写文档、别人不写注释、别人不写文档。 不错,今天我们就来谈谈程序员最讨厌做的这件事: 写注释!
程序员该不该写注释? 其实对于写注释这件事来说,还是有一定的争议的,争议其实不在于该不该写注释,而是在于不要过多的写注释,注释多了,反而会让你感觉整个代码比较混乱不堪,影响视觉。而且有人为什么不太鼓励大家过多的去写注释呢?因为代码即注释,何为代码即注释?代码是具有自解释功能的,高质量,命名规范的代码,其实程序员应该一眼就能够看懂这段代码的功能作用是什么? 所以,程序员到底该不该写注释? 事实证明:该,但是要注意分寸。
1.优秀的程序员可以少写注释~ 优秀的程序员都是懒的。因为懒,他才会写出各种各样的工具来替自己干活。因为懒,他才会想办法避免去写无聊重复的代码因此避免的代码的冗余,削减了代码的维护成本,使重构变得更加容易。 代码即注释。作为一个优秀的程序员,大多数都懂得注释不是用来翻译程序代码的,用代码能说清楚的东西,就自然不用费脑子去写注释了,集中精力写出最优雅、高质量的代码才是首要的。本身对于简短的代码,规范的命名、条理清晰的书写方式,让人一看就懂,那么本身这个代码就不需要注释,它自身就具有自解释功能。 当然,如果一个函数上百行代码,甚至更多,还是需要写一定的注释的,甚至在一个重要的业务逻辑处理的地方,还是需要注明一些注释的,毕竟时间久了,业务逻辑不熟悉了,看代码确实有些费劲。 2.初级中等程序员还是得写注释~ 作为一个入门,初级或者中等的程序员,在自己代码质量不高的阶段,时刻提醒自己养成一个好的写注释的习惯还是很有必要的。 为什么很多程序员不愿意接手别人写的代码,是因为有一个问题就是必然存在的。每个人的编码风格不一样,命名方式和规范不一样,加上由于程序员代码的个性化,就造就了代码的多样性。倘若再没有注释,谁还愿意看?所以,前期记住一定得写注释。 记住:与人方便就是与己方便。 为什么谈这个话题? 下面,小编带你走进奇葩的代码注释世界~ 呕出一口老血!
总结 代码即注释,写注释要注意分寸。如下: 用高质量的代码代替注释。 在复杂函数和重要的业务逻辑面试,还是必须要写注释的。 注释需要维护,不是写了就好。不维护,还不如不写。 要学会命名,遵守规范,这样才能够培养出好习惯。 -信息与软件工程学院2015级- 编辑/马鑫珑 文字/游戏蛮牛 图片/游戏蛮牛 指导老师/马嘉男 (文章转自游戏蛮牛) |
|
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系
[邮箱地址] 删除
|