现在在的公司代码注释全都是只有三四个单词或者一个短语,最长不超一句话,要看上下文猜意思,是普遍现象吗?例如 check terms / TODO sign check / index 0+1

235 天前
drymonfidelia  drymonfidelia
2532 次点击
所在节点   程序员  程序员
12 条回复
iintothewind
iintothewind
235 天前
很多时候代码不需要注释,
- 如果大部分方法都不超过三分之二屏幕,而且没多少成员变量,局部变量,这说明代码维护的还不错, 这种代码其实很好明白意思。

- 如果方法超级长, 超过两个屏幕长度。 而且是在维护 3 个以上成员变量, 频繁修改它们的状态,而且局部变量特别多, 频繁修改它们的状态。 毫无疑问, 这是烂代码, 不一定是一个人写的, 很可能是历史悠久的屎山代码,这种代码需要注释。

但屎山代码往往不是一个人维护的, 所以没人愿意负责,估计也没人愿意多写点注释。 即便偶尔写了注释, 如果逻辑改了, 注释又没同步更新, 那只能误导人,还不如没有。
iClass
iClass
235 天前
Ai 来帮您
bkmi
bkmi
235 天前
我觉得解释代码本身的注释没有太大意义,函数名,方法名通常就够了,除非是那些花哨的用法;
重要的是解释义务意图,上下文的一些关联,隐含的逻辑
MeteorVIP
MeteorVIP
235 天前
可能是普遍现象,但我会写注释,要不然看不懂别人写的代码。
chendy
chendy
235 天前
除非是复杂的算法,或者是为了性能之类的考虑做了某些诡异操作,否则代码本身不需要注释
相比于‘这段代码做了什么’,更重要的是‘解释为什么这么做’
tyrantZhao
tyrantZhao
235 天前
防御性编程
Perry
Perry
235 天前
不是普遍现象,但肯定是经验少的程序员的正常现象。
Perry
Perry
235 天前
要真防御性编程,连注释都可以懒得写,或者写好几行但也说了等于白说
drymonfidelia
drymonfidelia
234 天前
@Perry 之前负责这个项目的同事十年经验,给 React 提过好几个 PR 全部被合并了
InsideSeed
InsideSeed
234 天前
确实好的代码语义性强很容易方便其他开发者阅读和维护,但如果涉及到业务逻辑,那还是得有文档。
tomari
tomari
233 天前
GPT 一大用处就是帮忙写 function 的注释()
drymonfidelia
drymonfidelia
233 天前
@tomari 公司禁止 copilot 类直接上传代码的 AI 插件或者直接把代码贴给 GPT

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

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

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

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

© 2021 V2EX