읽기 좋은 코드 작성하기 - Swift API Design Guidelines

문서화 주석 실습

Promote Clear Usage 2 - 불필요한 단어를 생략하세요

Promote Clear Usage 3 - 타입 대신 역할에 따라 네이밍하세요

Promote Clear Usage 4 - 파라미터의 역할 드러내기

Strive for Fluent Usage 1 - method와 function을 영어 문장 처럼 사용할 수 있도록 하기

Strive for Fluent Usage 2 - initializer / factory method

Strive for Fluent Usage 3 - 부수효과(side-effect)를 기반해서 네이밍을 하세요

Strive for Fluent Usage 4

Use Terminology Well

General Conventions 1 - 시간복잡도가 O(1) 이 아닌 경우 주석 설명 / 전역 함수 지양

General Conventions 3

Parameter 1 - 주석을 읽기 쉽게 만들어주는 파라미터 이름을 선택하세요

Parameter 2 - default parameter

Argument Labels 1 - label을 써도 유용하게 구분이 되지 않는 경우 / 값을 유지하면서 타입 변환을 해주는 initializer

Argument Labels 2 - 첫 번째 argument가 전치사구의 일부일 때, argument label로 지정합니다

Argument Labels 3 - 첫번째 argument가 문법적 구절을 만든다면 label은 제거하고, 함수 이름에 base name을 추가합니다.

Special Instructions 1 - tuple members와 closure parameters에 Label을 붙이세요

Special Instructions 2 - overload set에서의 모호함을 피하기 위해, 제약 없는 다형성에 각별히 주의하세요

마무리