ruby - 在不烦人的情况下如何编码 “self-documenting”？

Closed. This question is opinion-based。它当前不接受答案。












想改善这个问题吗？更新问题，以便editing this post用事实和引用来回答。

2年前关闭。



Improve this question




我不确定这里有什么最佳实践，但是我经常看到缩写的变量名，尤其是在范围很小的时候。因此，(使用简单的Ruby示例)而不是def add_location(name, coordinates)，我看到了类似def add_loc(name, coord)的东西，甚至可能看到了类似def add_loc(n, x, y)的东西。我想如果长名字习惯于使用缩写，可能会使一个人厌烦。

冗长性会提高可读性，还是会伤害所有人的视线？-人们喜欢缩写和简称而不是长名称吗？

最佳答案

就个人而言，我宁愿看到更长的名称实际上意味着某些意思，而不必先确定上下文。当然，那些没有真正含义的变量(例如计数器)，我仍然使用小的无意义的变量名(例如i或x)，但是的冗长性在大多数情况下都是。对于公共(public)API尤其如此。

但是，这可能太过分了。我过去看过一些VB代码，这很荒谬。像其他一切一样节制!

关于ruby - 在不烦人的情况下如何编码 “self-documenting”？ ，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/214160/