野菜で覚える API Design Guidelines by Akihiro Kokubo

ここにトマトがあります。
このトマトを、幅を指定して切るメソッドについて考えてみましょう。

extension Tomato {
  public func slice(width: Double)
}

トマトを3cm幅でカットする際は、以下のように書けば良さそうです。

tomato.slice(width: 3)

さてここで、メソッドのシグネチャからwidthを省略したら、メソッドを使う側にどう伝わるでしょうか？

tomato.slice(3)

「トマトを3cm幅でカットする」ではなく、「トマトを3つにカットする」と伝わってしまうかもしれません。

Swift の API Design Guidelinesは、明確で一貫性のあるコードを書くための指針を教えてくれます。しかし、その抽象的な概念を理解し、日々のコーディングに適用するのは難しい場合があります。

本LTでは、身近な「野菜」を使って、これらのガイドラインの理解を深めていきます。野菜を使うことで抽象的な概念を具体的なイメージとして捉え、より実践的な知識として吸収し、より良いコードが書けるようになることを目指します！