我被要求在提交代码前删除我的注释

我从事信息技术行业已有12年，担任过全栈开发工程师和开发负责人。

最近，我遇到了职业生涯中从未面对过的问题：我的团队成员要求我在提交代码之前删除所有注释。

我们对此进行了讨论。他们中的一些人认为，代码中存在注释几乎总是表明代码本身不够清晰，因此这说明代码需要重写，直到不再需要注释为止。

我理解这种观点。
我读过《代码整洁之道》。我也采纳了书中描述的一些原则。但我也读过《软件设计哲学》，其中关于“深层模块”与“浅层模块”的概念让我深有共鸣。这并非本文的重点，因此我不再赘述——只想指出一点：在我们这个行业，关于是否使用注释的争论远未结束（也许永远不会结束？）。

回到实际情况。我向同事们解释，我在编码时采用了一种叙事式的方法，可以称之为“注释驱动开发”。我会先写下所有注释，反复修改、重构这些注释，然后才在注释下方编写实际代码。

这些注释帮助我梳理思路。它们是我工作记忆的延伸。没有它们，就像剥夺了我一部分认知能力。一旦写好，我在后续代码演进过程中阅读代码时仍会依赖这些注释：它们是我的导航链接。我的大脑已经习惯了这种方式，因此能快速扫视函数中的注释，迅速定位需要修改或调试的位置。

他们认真听了我的解释，也努力去理解，但最终的决定依然不变：他们希望代码库干净整洁，不要包含这类注释。在他们看来，这些注释没有用处，团队不会去阅读，更不会去维护。简而言之：不要噪音。

但对我来说，那些注释并不是噪音。
它们就是我的思考方式！

他们提出的唯一折中方案是在提交前删除我的注释。这个方案让我很不舒服。这样做太令人沮丧，而且长远来看会造成大量心智能量的浪费。同时，我也需要保持务实，尊重团队的决定。

深入问题本质：问题并不在于注释本身

Git 并不区分“思考”与“共享”。
Git 无法区分：

因此，如果我遵循同事们的规则，每次提交时都必须彻底清理代码。

删除我的注释。
打磨代码。
让它变得“体面可展示”。

对某些情况来说，这样做或许没问题……直到我意识到这对我的思考和编码方式意味着什么。

每次提交时，我都会删除：

我的 Git 历史记录会很干净。
但我的思考却消失了。

对我来说，这是不可接受的。

起初，这只是项目中的几个脚本。

目的是：

我并不仅仅在解决一个个人问题

免责声明：本文内容来自互联网，该文观点不代表本站观点。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，请到页面底部单击反馈，一经查实，本站将立刻删除。