我应该在提交消息或内联注释中写下推理吗？-解网

问：

我经常听说提交消息应该描述我为什么要进行这些更改。我想我同意这一点。但是，我也经常听说内联注释（即源代码中的注释）应该说明为什么代码以这种特定方式工作，而不是它做什么。

那么，我什么时候应该把推理放在提交消息中，什么时候应该写在内联注释中呢？是否有一些可以应用的经验法则或最佳实践？

git 注释 git-commit 提交消息

您将使用提交消息来解释进行更改的理由，包括为什么选择一种替代方法而不是另一种选择。例如，如果您选择了一种算法而不是另一种算法，例如，出于性能原因，则该算法属于提交消息。您还应该记录诸如促使更改的问题或想法之类的事情，以帮助向未来的读者解释为什么您的更改很有价值。

最终的区别在于，在前一种情况下，您希望它在读取代码时可见，而在后一种情况下，您可以期望相关方查看历史记录。

我应该在提交消息或内联注释中写下推理吗？