今天最窝心的文字:码农最讨厌两件事儿

2018-08-17 15:04:33 +08:00
 quu

码农最讨厌两件事儿:

1.码代码的时候写注释 2.接手别人代码没注释

真的扎心了,我先笑十分钟。

8742 次点击
所在节点    程序员
54 条回复
night98
2018-08-17 18:34:17 +08:00
@Decouple #28 是的,高质量的注释才叫注释,有些开发我就不想说了,注释基本上保持在五个字以内,这种注释除了他自己知道怎么回事之外,其他人看了还可能有歧义,所以保持注释的质量也是很重要的。
wzxlovesy
2018-08-17 19:01:52 +08:00
@night98 你的说法才不成立,注释太多反而容易引起误解,特别是注释没跟上代码的时候,你是该看注释还是代码?

『代码整洁之道』了解一下
ArthurMarcel
2018-08-17 19:20:56 +08:00
合理的注释才是关键~
iceheart
2018-08-17 23:11:17 +08:00
记性越来越差,一般先写注释,然后看着注释填代码。
不然写着写着就忘了先前的思路了
zj299792458
2018-08-17 23:19:53 +08:00
现代代码还需要注释么,函数变量名能长到换行,一个方法声明能写 10 行(没错我说的就是 OC),意思都一目了然,现代 IDE 调用时都是自动完成,只按前两个字母就全出来了,又不是嵌入式 c 代码,喜欢用单字母和缩写……

个人感觉注释已经沦为屏蔽代码的工具了,很多时候看注释掉的代码能知道当年这里有什么问题,企图怎样做……
ykrl089
2018-08-17 23:56:06 +08:00
@hxhc 注释写的比代码还多!
skylerlin
2018-08-18 00:07:18 +08:00
真的笑,笑出声
sampeng
2018-08-18 00:19:26 +08:00
写不写注释都有理由…这也要争论讨论一番?写注释的改变不了不写注释的习惯,不写注释的改变不了写注释的习惯。

简单的逻辑写注释也是浪费时间。除非是一个模块设计,或者是代码组织设计,这有必要。但简单逻辑像数据库操作、楼上举例分页之类的。真没多少注释好写,理解注释的意思一样要花时间。我宁愿直接看代码逻辑。当然顺手写出超过 50 行-100 行的大函数习惯的人肯定无法理解这个思维过程…

开源项目不写注释提交代码都是问题。不在讨论范围之列


接手代码完全没注释也是分情况的,简单项目…反正要推掉重来的。复杂项目,交接会大体有个逻辑线会讲清楚。什么?超级垃圾代码项目?我加班加点重写可好…
MonoLogueChi
2018-08-18 00:54:33 +08:00
注释我一般都是写完一段之后再去补的,不习惯思路被打断。另外注释真的很重要,比如当我调用一个函数的时候,如果没有注释,我可能需要去找这个函数再看一遍才能确定参数。
jmk92
2018-08-18 01:28:32 +08:00
思路用注释写一遍,写代码轻松很多。
比如,
//把冰箱门打开
....开始码代码
//把长颈鹿放进去
....
//把门关上
...
Mrkon
2018-08-18 10:57:00 +08:00
最好还是精简注释,然后函数使用好的命名方式。
leekafai
2018-08-18 11:32:51 +08:00
我一般先写注释再写代码的。写好了注释,搞清楚自己要干嘛,然后去装杯水,回来再写代码,最后测试完了,删掉一部分不必要的注释。
YogurtTnT
2018-08-18 12:49:46 +08:00
哇,那源码中的那么多注释怎么说 AQS 那注释都是一篇文章🤔
e8c47a0d
2018-08-18 20:33:27 +08:00
首先接手别人的代码这件事本身就窝心🙄

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/480741

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX