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

• 请不要在回答技术问题时复制粘贴 AI 生成的内容

You need to sign in to view this topic

This topic created in 691 days ago, the information mentioned may be changed or developed.

注释

简短

上下文

12 replies • 2024-06-23 17:24:11 +08:00

iintothewind

Jun 22, 2024

很多时候代码不需要注释，
- 如果大部分方法都不超过三分之二屏幕，而且没多少成员变量，局部变量，这说明代码维护的还不错，这种代码其实很好明白意思。

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

但屎山代码往往不是一个人维护的，所以没人愿意负责，估计也没人愿意多写点注释。即便偶尔写了注释，如果逻辑改了，注释又没同步更新，那只能误导人，还不如没有。