Swift.org

• 목차

Basic

• 사용 시점의 명확성. 메서드 및 속성과 같은 엔티티는 한 번만 선언되지만 반복 사용. API를 명확하고 간결하게 사용하도록 설계 해야함.
• 간결함보다는 명료함이 더 중요하다. Swift 코드는 간결할 수 있지만 가장 적은 문자로 가능한 가장 작은 코드를 짜는것이 목표가 아니라 자연스럽게 상요구를 줄이는 것.
• 모든 선언에 대한 문서 주석을 작성하라.

Markdown

• 선언되는 엔티티를 설명하는 요약으로 시작.

/// Returns a "view" of `self` containing the same elements in
/// reverse order.
func reversed() -> ReverseCollection

• 요약에 중점을 둔다.
• 가능하면 마침표로 끝나는 단일 문장을 사용.
• 함수 또는 메서드가 수행하는 작업과 반환하는 내용을 설명.

/// Inserts `newHead` at the beginning of `self`.
mutating func prepend(_ newHead: Int)

/// Returns a `List` containing `head` followed by the elements
/// of `self`.
func prepending(_ head: Element) -> List

/// Removes and returns the first element of `self` if non-empty;
/// returns `nil` otherwise.
mutating func popFirst() -> Element?

참고: 위와 같은 경우는 드물지만 popFirst의 요약은 세미콜론으로 구분된 여러 문장으로 구성

• 아래의 매개변수가 무엇에 액세스하는지 설명하십시오

/// Accesses the `index`th element.
subscript(index: Int) -> Element { get set }