16.3 注释属于代码，而不是提交日志

在修改代码时，一个常见的错误是把修改的详细信息放在源代码库的提交消息中，但不把它记录在代码中。虽然提交信息可以在将来通过查看版本库的日志来浏览，但需要这些信息的开发者不太可能想到查看版本库的日志。即使他们真的查看了日志，要找到正确的日志信息也会很繁琐。

在写提交信息的时候，问问自己，开发人员是否在将来需要使用这些信息。如果是，就在代码中记录这些信息。一个例子是，提交信息描述了一个促使代码改变的微妙问题。如果这一点没有记录在代码中，那么一个后来的开发者可能会撤消这个变更，而没有意识到他们已经重新创建了一个bug。如果你想在提交信息中也包括这些信息的副本，那也行，但最重要的是把它写在代码中。这说明了将文档放在开发者最可能看到的地方的原则；提交的日志很少会成为这个“地方”。