《事业-最佳实践-编码》系列

原则

• 关注点分离

• 完全穷尽，彼此独立

• 一个接口应该只做一件事情

维度

职责：

• 单一：每个接口只负责一个相关的功能领域。

• 易用：使用者能够轻松理解和调用接口的方法。

• 兼容：修改对现有实现的影响尽可能降低，或通过向后兼容的方式进行变更。

• 遵循原则：符合领域或系统的整体架构和设计原则。

文档：

• 接口的文档和注释完备，包含接口级别的描述、用法说明和其他相关信息。

命名：

• 接口名称清晰、准确，能够准确表达其职责和功能。

• 方法命名简洁、明了，能够准确描述其操作和目的。

方法：

• 数量：接口的方法数量适度，不过于庞大或冗余。

• 注释：每个方法有适当的文档注释，描述其用途、输入、输出以及特殊注意事项。

• 入参： 方法的输入参数类型和顺序合理，并且能够满足使用者的需求。

• 返回： 方法的返回值类型符合预期，能够准确表达方法的结果。