java - 列表变量的命名约定

Question

我有一个问题，对许多人来说似乎微不足道，但它让我反复思考我编写的代码的可读性。

假设我有一个类封装了实体的详细信息，例如员工，名为 EmployeeDetails . (注意 - 我还有一个名为 Employee 的类，它存在于 DAO 层。我不想从我的服务方法中返回任何 DAO 级别的类，这就是为什么我创建了要从我的服务返回的 EmployeeDetails 类层方法。我还想通过使服务层和 DAO 层类名称不同来避免类名称之间的混淆。

我还有一个服务级别方法，给定一个员工编号列表，返回一个 List<EmployeeDetails> .我的问题是——命名返回变量的最佳编码约定是什么？我有两个选择。

1. employeeDtls - 我不喜欢这样，因为阅读我的代码的人可能认为“employeeDtls”指的是 EmployeeDetails 的一个实例而不是列表。
2. employeeDtlsList - 我不喜欢这个，因为它看起来“太罗嗦了”。

是否有人遵循任何特定的变量编码约定？列表变量使用最广泛的命名约定是什么？

Answer 1

好吧......让我们考虑一下我们在这里建模的内容。

一般的经验法则是，如果它是一个集合，那么它应该是复数形式，并且范围限定为您期望的内容。

那么，这将使您的变量名称为 List<EmployeeDetails> details或 List<EmployeeDetails> employees .如果可以，请尽量避免使用复合名称，除非它真正具体地代表了您要返回的内容。

如果您使用的是 Data Transfer Object模型，并且您将其命名为 EmployeeDto , 那么变量的名称将在 employees 处更具体，正如您期望的那样，返回一些代表 Employee 的 something 集合(在其核心)。