Я поддерживаю код математического алгоритма, взятый из книги, со ссылками в комментариях. Что лучше - иметь имена переменных, описывающие то, что они представляют, или переменные должны соответствовать тому, что написано в книге?
В качестве простого примера я могу увидеть этот код, который отражает переменную в книге.
A_c = v*v/r
Я мог бы переписать его как
centripetal_acceleration = velocity*velocity/radius
Преимущество последнего в том, что любой, кто смотрит код, может его понять. Однако преимущество первого заключается в том, что код легче сравнивать с тем, что написано в книге. Я могу сделать это, чтобы дважды проверить реализацию алгоритмов, или я могу добавить дополнительные вычисления.
Возможно, я слишком много думаю об этом и должен просто использовать комментарии для описания переменных. Однако я предпочитаю самодокументированный код (используйте описательные имена переменных вместо добавления комментариев для описания того, что они собой представляют), но, возможно, это тот случай, когда комментарии будут очень полезны.
Я знаю, что этот вопрос может быть субъективным, но Мне было интересно, есть ли у кого-нибудь руководящие принципы для принятия решения или ссылки на рекомендации по кодированию математических алгоритмов.