请保持代码描述简洁 | AksDev
请保持代码描述简洁 | AksDev
这是我最近越来越多遇到的情况。在审查代码时，描述、提交信息等常常是一大堆信息爆炸：充斥着描述变更的无关细节。关键点在于为什么要变更。而且往往只有一个巨大的提交，包含海量的差异。
抱歉，我可怜的ADHD（注意力缺陷多动症）大脑实在难以消化。我不想读一本小说。通常简短的文字就够了：如果我想知道，可以问那些无关的细节。
所以，这是我的恳求——从可访问性（？）的角度出发——请保持提交信息、合并请求描述和代码注释清晰、切中要点、仅需知即可。不要解释什么变了，而要解释为什么变。通常代码本身足以说明其余内容。如果不够，我会提问。这才是审查的意义。
很容易觉得用巨长的描述包罗万象才是正确做法，但这只会让我这样的人审查得更慢。我已经很难集中注意力了……
而且提交应该始终是原子性的，尤其是在合并审查时。使用git amend进行小修改。在合并之前，rebase并清理，或者squash。但请尽量保持提交原子性：每个变更独立成块。
（注意：这不是针对任何特定个人，只是我终于有脑子写下这篇文章，因为我又想起了这个话题。）
如果你使用LLM（大语言模型）工具，请仍然自己编写注释、描述、提交信息等。这有助于你理解正在发生的事情，也让我更容易审查。（或者更棒的是，尽量避开这些工具。我认为没人真的需要它们。没有它们你也很棒，我保证！）
编辑：似乎有人对我提到“可访问性”感到不满。我不知道用哪个词描述最好。但如果这篇文章让你不爽，直接忽略就好。