请保持代码描述简单

# 请保持代码描述简洁 | AksDev Source: https://akselmo.dev/posts/please-keep-code-descriptions-simple/ 这只是我这些天越来越常遇到的事情。 在审查代码时，描述、提交等可能会成为信息大爆炸：充满了关于更改内容的无关细节。关键在于为什么做了更改。而且常常只有一个巨大的提交，带着大量差异。 抱歉，但我可怜的ADHD大脑难以承受。我不想读一本小说。通常简短的文字说明就够了：多余的细节我可以在需要时询问。 所以，从纯粹的可访问性角度出发，我恳请将提交信息、合并请求描述和代码注释保持清晰、切中要点、仅包含必要信息。不要解释是什么，而是解释为什么。通常代码本身足以说明其余故事。如果不是，我会提问。这就是审查的目的。 很容易认为包含一切的大段描述是正确做法，但这只会让我这样的人审查得更慢。我已经很难集中注意力了…… 此外，提交应始终保持原子性，尤其在合并审查期间。使用git amend进行小修改。合并前，进行变基和清理，或压缩提交。但要尽力保持提交原子性：独立存在的更改。 （注意：这并非针对任何特定个人，只是我因为想起这个话题，终于有心思写下这篇文章。） 如果你使用LLM工具，请仍然自己编写注释、描述、提交信息等。这有助于你理解正在发生的事情，也让我更容易审查。*（或者更好的是，如果可以的话，尽量避免使用这些工具。我不认为有人真的需要它们。没有它们，你也足够优秀，我保证！）*