API Design Guidelines 📙

1️⃣ Naming

• 모호함을 피하기 위해 변수나 함수가 하는 일의 모든 단어를 포함해야함

extension List {
  public mutating func remove(at position: Index) -> Element
}
employees.remove(at: x)

• 중요한 정보만 들어가야하고 중복이나 불필요한 정보가 이름에 들어가면 안됨

public mutating func remove(_ member: Element) -> Element?

allViews.remove(cancelButton) // clearer

• 타입이 이름에 들어가면 안되고, 역할이 이름에 들어가야함

// var string = "Hello"
var greeting = "Hello"
protocol ViewController {
  // associatedtype ViewType : View
  associatedtype ContentView : View
}
class ProductionLine {
  // func restock(from widgetFactory: WidgetFactory)
  func restock(from supplier: WidgetFactory)
}

• 프로토콜 이름이 역할이 되는 경우 프로토콜이름에 Protocol을 추가하여 충돌을 피해야함

protocol Sequence {
  associatedtype Iterator : IteratorProtocol
}
protocol IteratorProtocol { ... }

• 메서드를 선언하는곳과 사용하는 곳에서 매개변수의 역할을 명확히 나타낼 수 있어야함

// func add(_ observer: NSObject, for keyPath: String)
func addObserver(_ observer: NSObject, forKeyPath path: String)
// grid.add(self, for: graphics) // vague
grid.addObserver(self, forKeyPath: graphics) // clear

2️⃣ Strive for Fluent Usage

Tip

• initailize, get, set, make 대신 generate, configure를 사용

---

출처📚

🍎Apple Docs: api-design-guidelines