同事写的注释实在太多余了

2020-08-23 13:18:32 +08:00
 wuzhouhui
例如声明变量和函数之前, 都要写一行注释

// 声明变量
// 声明函数

大家都是成年人, 哪有人不知道这是在声明, 至于写个注释吗? 放锁写个注释, 解锁再写个注释. 都三十好几的人了, 也不看看其他人是怎么写代码的, 都说了不要写多余的注释, 还不肯改
16268 次点击
所在节点    程序员
103 条回复
fffang
2020-08-23 15:50:24 +08:00
@lithbitren 一般不是直接写 //XX (用途)吗,真有人会写“声明”“变量”吗?
lithbitren
2020-08-23 16:03:42 +08:00
@fffang 变量还行,反正写上用途就行,多写几个字把句子补完也无妨,函数光写用途关键字有时候也搞不清楚
gdzzzyyy
2020-08-23 16:06:52 +08:00
我觉得挺好的。又不耽误你什么事情。个人习惯而已,而且这个习惯还是好习惯。
wellsc
2020-08-23 16:12:27 +08:00
等接手没有注释的代码,加班加到吐,你就不会这么说了
Maboroshii
2020-08-23 16:17:40 +08:00
针对这一点来说,的确是多余注释
imn1
2020-08-23 16:24:52 +08:00
多余,是因为他的变量命名规范

如果
a=
a1=
a2=
……
估计你也坐不住,要动手加注释
taogen
2020-08-23 16:49:46 +08:00
无可厚非。

他愿意加是他的事,无论是充满毫无意义的注释,还是没有任何注释,代码要看还是得看。
tinycold
2020-08-23 17:32:17 +08:00
上 V 站的吐槽这么铿锵有力,不知道你有没有当面给到他 feedback,在 code review 中,或是私底下。

如果有,那我支持你。
如果没有,我觉得就本质上大家都没啥区别,就是领工资混日子罢了,你对他的吐槽也不是出于对"高可读"代码的追求。
YaakovZiv
2020-08-23 17:46:32 +08:00
@imn1 太真实了,如果是解释一下变量命名给谁用的,我觉得可以理解。
binjoo
2020-08-23 17:56:31 +08:00
程序员两个不喜欢:

1. 不喜欢写注释;
2. 不喜欢别人不写注释;
aliveyang
2020-08-23 18:48:26 +08:00
可能他是先写注释,理清思路再写代码吧
aliveyang
2020-08-23 18:49:57 +08:00
应该是个习惯问题
zhenghuiy
2020-08-23 18:58:20 +08:00
楼主就不该来这里吐槽,看到那些评论是不是更生气了。🤣

同时也吐槽,楼上几个连客观的对错都不分了么。。明显无意义的注释都能杠一下「等碰到不写注释的就有你受的了」—— 生活虽苦但自己对于优劣的标准不能放弃呀。
jerryrib
2020-08-23 19:03:13 +08:00
joiejia
2020-08-23 19:26:52 +08:00
代码也不一定都是给同行看的。我做 seo 的,不会写代码,只看得懂工作相关部分,有时候看网页代码还能不能再优化精简时,有注释是能帮到我的。
windfarer
2020-08-23 19:49:16 +08:00
你见过用日语写注释的就不会有这么多抱怨了
uiosun
2020-08-23 19:55:07 +08:00
@chinvo

“难懂逻辑”——这四个字几乎概括了从萌新到大牛,一路上所有的逻辑,毕竟与其你按自己水准来断定“难懂逻辑”,不如写全点。

就怕这个哥们一天代码 50 行,剩下时间都顾着写逻辑了……
Felldeadbird
2020-08-23 20:55:26 +08:00
有可能是 ide 自动生成。
Seanfuck
2020-08-23 21:00:32 +08:00
变量名和函数名用英文写清楚,就不需要注释,写了多余
guanhui07
2020-08-23 21:04:32 +08:00
程序员两个不喜欢:

1. 不喜欢写注释;
2. 不喜欢别人不写注释;

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

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

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

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

© 2021 V2EX