java - 命名返回对象列表的方法的最佳方法

Question

我有一个名为 ActivityLog 的类。此类包含 ActivityRecords 列表。我想根据以下标准返回 ActivityRecords 列表:环境和条件。方法名称是否应包含“条件”？参见示例:

activityLog.allRecords();
activityLog.allRecordsBy(Environment environment);
activityLog.allRecordsBy(Condition condition);
activityLog.allRecordsBy(Condition condition, Environment environment);

或

activityLog.allRecordsByEnvironment(Environment environment);
activityLog.allRecordsByCondtion(Condition condition);

我可能认为第一个更好，因为您将阅读方法名称并从参数中了解它的作用，但我可能错了？哪个最好，或者有更好的选择吗？

我也可以将这些方法命名为 records()、recordsBy 等，但我希望通过我的 API 保持一致性，您始终可以在其中开始编写 all 用于对象列表，因此您可以从 Intelli Sense 等方面获得帮助。

Answer 1

我喜欢将条件放在实际的方法名称中。所以我会使用:

activityLog.allRecordsByEnvironment(Environment environment);

对我来说，正确的方法命名表达了方法作用的一个小总结。由于参数包含在方法签名中，我不会将参数视为实际名称的一部分，因此不将条件放在名称中会给 api 用户提供有关方法功能的不完整信息。 (海事组织)

我赞赏您为练习自文档化代码所做的努力，很棒的练习。