language-agnostic - 您是否使用特定的约定来命名互补变量？

Question

我经常发现自己试图为互补的变量对取个好名字。其中两个变量表示相反的概念，两个参与者在某种形式的对话中，等等。

这可能通过一个反例更好地解释 - 我维护一个应用程序，它打印两个图形作为打印广告的一部分。它们在数据库中存储为 TopLogo和 LowerLogo ，我每次使用它们时都必须停下来仔细检查，因为我期待 top补充bottom , 和 lower应该补充 upper .

有一些我认为效果很好的明显例子:
client / serversource / target用于将数据或文件从一个变量复制/移动到另一个变量minimum / maximum
但是有些概念不适合这种简洁的命名方案。例如，在对记录进行分页时，“last”是指“final”还是“previous”？我最近看到了一些使用 firstPage 的代码, previousPage , nextPage和 finalPage避免模​​棱两可的lastPage完全，我认为这是非常节拍的，因此提出了这个问题。

您有什么特别简洁的变量名对想与我们分享吗？ (如果它们的长度相同，则加分，这使得等宽字体中的代码更加整洁。)

Answer 1

与各种代码样式约定一样，一致性 是你应该争取的。
我会让开发团队就“源/目标”或“从/到”等常见场景的“标准”前缀对达成一致，然后在整个项目中坚持使用它们。只要每个开发人员都知道代码库中特定前缀的含义，就更容易避免误解。
如果变量是公共(public) API 的一部分，则应在文档中阐明规则的异常(exception)情况，或者在代码中的注释中说明，如果它的可见性仅限于单个类或方法。