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

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

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

大家都是成年人, 哪有人不知道这是在声明, 至于写个注释吗? 放锁写个注释, 解锁再写个注释. 都三十好几的人了, 也不看看其他人是怎么写代码的, 都说了不要写多余的注释, 还不肯改
16234 次点击
所在节点    程序员
103 条回复
constexpr
2020-08-23 13:20:48 +08:00
强迫症吧
kaiki
2020-08-23 13:21:32 +08:00
真没必要拿出来说吧,愿意把注释写成说明书的人真不多了。
democracier
2020-08-23 13:32:48 +08:00
多了嫌冗余,少了嫌不清晰 真难伺候
inwar
2020-08-23 13:33:44 +08:00
ide 自动生成的吧
chinvo
2020-08-23 13:34:27 +08:00
这种就明显是“没意义的注释”

注释应该是对难懂逻辑的说明
qsnow6
2020-08-23 13:35:30 +08:00
愿意写就算及格了,至于写的是否足够简洁、易懂,要经过长期刻意练习才能做到。
Jooooooooo
2020-08-23 13:38:07 +08:00
有注释总是比没有好
Procumbens
2020-08-23 13:40:27 +08:00
https://www.reddit.com/r/ProgrammerHumor/comments/i4v6b2/comments/
莫名想到了之前 Reddit 看到的 ProgrammerHumor 里的一则帖子 hhh
leafre
2020-08-23 13:42:59 +08:00
不写可以了吧
finab
2020-08-23 13:46:06 +08:00
我的配色注释是灰色,代码颜色是亮色系。
我阅读代码时基本感觉不到注释的存在,写啥都行,推荐试试
Vegetable
2020-08-23 13:49:24 +08:00
为了注释而注释,脑子不清楚的表现。
nicevar
2020-08-23 13:51:10 +08:00
如果有 sonar 检查,这样是很正常的操作
CEBBCAT
2020-08-23 13:51:23 +08:00
https://www.v2ex.com/t/661193
https://www.v2ex.com/t/661196
https://www.v2ex.com/t/700675

从节点的选择中,确实能感受得到楼主对真理的追求
anguiao
2020-08-23 13:54:31 +08:00
感觉我遇到的同事,大部分都是以下两种:
1.无用注释一堆,代码该看不懂的还是看不懂;
2.基本上没几句注释,但代码条理还算清晰,耐心看还算能看懂。
代码写得好、注释又清晰的,是真的少,可能我身边的人都太菜了吧。
wangzp0303
2020-08-23 14:28:22 +08:00
才知道还有个“签证”区,话说代码相关的讨论为啥放“签证”区
rouzip
2020-08-23 14:34:40 +08:00
每个人状态不同,能力不同对于同段代码的理解也不同,需要看懂的时间也不同。注释不仅仅是规范化输入输出,更是清晰地告诉后来人,这个函数是什么,预期结果如何等等,让后人更加快速地了解这个函数,如果每个人都是 super star 级别的,全程跟项目,注释作用可能不明显,但是对于新人或者刚接触某个大型工程,可以让别人更好上手,省去大量时间看代码,跳逻辑。刚入行的实习新人,欢迎大家指正。
louishwh
2020-08-23 15:17:13 +08:00
总比一行不写的强,有的不加注释自己写的都看不懂
laike9m
2020-08-23 15:27:01 +08:00
不要光说,代码放出来看一下就知道多不多余了。一般而言如果确实只写了你说的这几个字,那确实多余。
lithbitren
2020-08-23 15:29:04 +08:00
声明变量是挺多余的

声明 XX 变量有时候还是需要,光靠变量名很多时候不能一眼推断出是干啥的变量
lzlee
2020-08-23 15:31:50 +08:00
所以这个人代码质量怎么样
他的注释影到底影响了什么
你给他提了明确的文档标准吗

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

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

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

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

© 2021 V2EX