🔥 주석

Swift에서 주석(Comments)은 코드에 포함되지만 컴파일러가 무시하는 텍스트예요. 주석은 코드에 대한 설명이나 메모를 남길 때 유용하게 사용할 수 있지요.

한 줄 주석(Single-line Comments)

한 줄 주석은 //로 시작하며, 해당 줄의 끝까지 주석으로 처리된답니다.

// 이것은 한 줄 주석이에요.
let x = 10 // 변수 x에 10을 할당해요.
swift복사

여러 줄 주석(Multi-line Comments)

여러 줄에 걸친 주석을 작성할 때는 /*로 시작하고 */로 끝내요.

/* 이것은 여러 줄 주석이에요.
   주석은 여러 줄에 걸쳐 작성할 수 있어요. */
swift복사

C언어와 달리, Swift의 여러 줄 주석은 중첩될 수 있어요. 즉, 주석 안에 또 다른 주석을 포함시킬 수 있죠.

/* 첫 번째 여러 줄 주석의 시작이에요.
    /* 두 번째로 중첩된 여러 줄 주석이에요. */
첫 번째 여러 줄 주석의 끝이에요. */
swift복사

이렇게 중첩된 주석을 사용하면 이미 주석이 포함된 큰 코드 블록을 빠르고 쉽게 주석 처리할 수 있어요.

문서화 주석(Documentation Comments)

Swift에서는 ///로 시작하는 문서화 주석을 사용하여 코드의 문서를 자동으로 생성할 수 있어요. 문서화 주석은 함수, 클래스, 구조체, 열거형 등의 선언 바로 앞에 작성하면 돼요.

/// 사용자의 나이를 계산하는 함수예요.
///
/// - Parameter birthYear: 사용자의 출생 연도예요.
/// - Returns: 사용자의 나이를 반환해요.
func calculateAge(birthYear: Int) -> Int {
    let currentYear = 2023 // 현재 연도예요.
    return currentYear - birthYear // 나이를 계산해요.
}
swift복사

위 코드에서는 ///로 시작하는 문서화 주석을 사용하여 함수의 설명, 매개변수, 반환 값에 대한 정보를 제공하고 있어요. 이렇게 문서화 주석을 작성하면 Xcode의 Quick Help나 jazzy 같은 도구를 사용하여 자동으로 문서를 생성할 수 있답니다.

주석은 코드의 의도를 명확히 하고, 복잡한 로직을 설명하는 데 도움을 줍니다. 적절한 주석 사용은 코드의 가독성과 유지보수성을 크게 향상시킵니다.

하지만 주석을 과도하게 사용하면 오히려 코드를 읽기 어렵게 만들 수 있으므로, 주석은 꼭 필요한 경우에만 사용하는 게 좋아요. 가능하면 코드 자체로 의도를 명확히 드러내는 것이 더 바람직한 방법입니다.