[Swift] 스위프트 주석 총정리

한 줄 주석

- 슬래시 두 개를 사용함

// MARK: - 한 줄 주석
// 한 줄 주석은 슬래시 두 개를 사용하여 표현

 

여러 줄 주석

- 슬래시와 별표를 사용함

// MARK: - 여러 줄 주석
/*
 여러 줄 주석을 시작할 때는 슬래시와 별표를 사용합니다.
 이 줄의 앞에는 별다른 표기가 없지만 이 줄도 주석으로 인식합니다.
 주석을 끝내고 싶을 때는 별표를 먼저 쓰면 됩니다.
 */
 
/*
 한 줄만 주석을 달아도 무방합니다.
 */

 

중첩 주석

- 스위프트에서는 중첩 주석을 지원한다.

// MARK: - 중첩 주석
// [TIP] 대부분의 프로그래밍 언어는 중첩 주석을 지원하지 않습니다.

/*
 여러 줄 주석 안쪽에
 /*
 추가로 여러 줄 주석을 포함할 수 있으며
 // 그 안에 한 줄 주석을 추가하여도 무방합니다.
 */
 이 부분도 주석처리 됩니다.
 */

 

문서화 주석

- 변수, 상수, 클래스, 메서드, 함수, 열거형 등을 설명할 경우

  마크업 문법에 따라 주석을 작성하면 다른 프로그래머가 '퀵헬프'를 통해 해당 내용을 확인할 수 있다.

  형식을 맞추는 일은 번거롭지만 문서화에 큰 도움이 되므로 사용할 것을 권장한다.

 

- 문서화 주석 생성 단축키 : command[⌘] + option[⌥] + [/]

- 문서화 주석에서 한 줄 주석은 슬래시 세 개, 여러 줄 주석은 별표 두 개를 사용한다.

// MARK: - 문서화 주석
/// 한 줄 문서화 주석
/**
 여러 줄 문서화 주석
 */

 

퀵헬프 및 마크업 문법 정리

charmintern.tistory.com/41

[Swift] Xcode 퀵헬프 및 마크업 문법

 

[출처 : 스위프트 프로그래밍 3판 - 야곰]