那些年我们写过的「注释」——代码注释奇葩大赏

760 字

4 分钟

那些年我们写过的「注释」——代码注释奇葩大赏

2026-08-10

其他

代码注释

/

程序员笑话

/

编程趣闻

代码注释的初衷很简单：解释这段代码在干什么。但现实中，注释往往成了程序员的情绪出口、免责声明，甚至是行为艺术。打开任何一个存在超过两年的项目，你大概率能在注释里找到比代码本身更精彩的内容。

甩锅型：「这不是我的问题」#

这类注释的核心诉求是——如果出了问题，别找我。

1
// 这段代码是我凌晨三点写的，我当时不知道为什么这样写，
2
// 但现在它能跑，所以我也不敢动它。
3
// 如果你改了它导致任何问题，请不要在 git blame 里找到我。
4
const magicNumber = 42;

1
// 此处逻辑来源于产品经理的"小需求"
2
// 如有疑问，请联系 PM（已离职）
3
apply_discount_logic()

更精炼的版本：「If you remove this line, the program will crash. Don’t ask me why.」

自嘲型：「我知道我很菜」#

自嘲是程序员的传统美德。这类注释往往带着三分无奈、七分真诚。

1
// 以下代码使用了「暴力枚举法」
2
// 时间复杂度 O(n³)，但 n 目前最大只有 3，所以理论上没问题
3
// —— 当然，这只是我的借口
4
for (int i = 0; i < list.size(); i++) {
5
  for (int j = 0; j < list.size(); j++) {
6
    for (int k = 0; k < list.size(); k++) {
7
      // ...
8
    }
9
  }
10
}

另一个经典：

1
// TODO: 重构这段代码
2
// 但我已经对着它看了三个小时了，
3
// 现在只想回家躺平。
4
// —— 2024年3月15日

而这个 TODO 对应的日期，往往比项目的第一个 commit 还早。

诚实型：「说出来你可能不信」#

有时候，真相就是这么朴实无华。

1
/*
2
 * 这个 z-index 的值之所以是 99999，
3
 * 是因为 modal 被 navbar 挡住了（z-index: 1000），
4
 * navbar 被 dropdown 挡住了（z-index: 5000），
5
 * dropdown 被 tooltip 挡住了（z-index: 10000），
6
 * 我不想重构整个 z-index 体系，所以……
7
 */
8
.modal { z-index: 99999; }

还有这种：

1
// 我承认这一段是从 Stack Overflow 复制的
2
// 链接：https://stackoverflow.com/questions/xxxxx
3
// 我现在看不懂，但能跑就行

诚实得让人不忍责备。

过度防御型：「我预判了你的预判」#

1
// ======================================================
2
// WARNING: DO NOT MODIFY THE CODE BELOW
3
// 如果你觉得你能优化它，相信我，你不能。
4
// 我们试过了。三次。每次都以回滚告终。
5
// 请尊重前人的血泪教训。
6
// ======================================================