Xcode 퀵헬프 사용 & 마크업 적용한 주석 사용

Xcode 에는 레퍼런스 문서의 요약된 내용을 보여주는 퀵헬프라는 기능이 있습니다.
코드작성중 레퍼런스 문서로 이동하지 않고 데이터타입이나 메서드 등의 간단한 정보를 확인할 수있는 아주 유용한 기능입니다.

<퀵헬프 보기>

원하는 항목(변수, 상수, 함수, 메서드, 타입 등등) 위에 마우스 커서를 놓고

option 키를 누른 상태로 클릭 or command + option + 2

통해 퀵헬프를 확인 가능합니다.

<마크업 형식에 따라 주석작성>

원하는 항목 (상수, 변수, 함수 등)에 마우스 커서를 위치한 후 

command + option + / 

ex)

enum HelloError : Error{

    case noName

    case unknown

}

HelloError 위에 마우스 커서를 위치 한 후 단축키를 누르면 (command + option + / )

/// <#Description#>

///

/// - noName: <#noName description#>

/// - unknown: <#unknown description#>

enum HelloError : Error{

    case noName

    case unknown

}

이렇게 마크업이 적용된 주석이 생성됩니다.

주석의 내용을 바꾸어 주고 퀵헬프 단축키를 누르면

/// 오류 타입의 열거형입니다.

/// - noName: 이름을 전달받지 못했을 때 발생하는 오류

/// - unknown: 알 수 없는 오류

enum HelloError : Error{

    case noName

    case unknown

}

원하는 항목 커서위치 > option 키를 누른 상태로 클릭 or command + option + 2

이렇게 퀵헬프 창에 나타납니다.

더 자세한 내용은 Markup Formatting Reference 를 참조하세요

출처 : 야곰님의 스위프트 프로그래밍