提示5-21：尽量简洁地描述或定义内部接口！

#building-block #interface #lean

尽量简洁地描述或指定内部接口：如果需要，您可以在源代码中找到任意接口详细信息。

特别注意图形界面描述（如UML）。

看看下面的图表，其中Blurp为消费者FooBar提供了方法/服务blurp。

1

FooBar => blurp() => Blurp

您可以为这个简单的图形模型添加更多详细信息，下面给出了一些选项（尽量简洁地）。

• 您不会解释此界面，因为您知道相应的源代码是可以理解或足够简单的
• 您解释了使用此界面的语义，即由该接口处理的业务流程，此接口的业务或技术后果，潜在的副作用
• 您解释了调用的返回类型和参数（假设同步交互）
• 您还描述了此界面所需或提供的质量属性，即：
• Blurp每秒可以处理10个请求，或者
• Blurp只能按顺序调用。
• 多个客户端调用Blurp将导致运行时异常。