math - 编码数学算法 - 我应该使用书中的变量还是更具描述性的变量？

Question

我正在维护来自一本书的数学算法的代码，并在评论中提供引用。使用描述变量代表什么的变量名称更好，还是变量应该与书中的内容相匹配？

举个简单的例子，我可能会看到这段代码，它反射(reflect)了书中的变量。

A_c = v*v/r

我可以将其重写为

centripetal_acceleration = velocity*velocity/radius

后者的优点是任何查看代码的人都可以理解它。但是，前者的优点是更容易将代码与书中的代码进行比较。我可能会这样做是为了仔细检查算法的实现，或者我可能想添加额外的计算。

也许我想得太多了，应该简单地使用注释来描述变量是什么。然而，我倾向于支持自记录代码(使用描述性变量名称而不是添加注释来描述它们是什么)，但也许在这种情况下注释会非常有用。

我知道这个问题可能是主观的，但我想知道是否有人有任何指导原则来做出决定，或者是否有数学算法编码指南的链接。

Answer 1

我更喜欢使用更具描述性的变量名称。您不能保证每个要查看代码的人都可以访问“这本书”。你可能会离开并拿走你的副本，它可能会绝版等等。在我看来，最好是描述性的。

我们在工作中使用了很多数学引用书，并在评论中引用了它们，但我们很少使用相同的数学缩写变量名。