[Swift] 주석

주석이란?

프로그래밍에 있어 소스코드에 정보나 내용을 메모를 남기는 목적으로 사용

 

• 한 줄 주석

// 한 줄 주석은 // 를 사용

 

• 여러 줄 주석

/* 여러 줄 주석은 슬래시와 별표를 사용
 시작은 슬래시와 별표, 종료는 별표와 슬래시 사용 */

/*
 여러 줄이 아닌 한 줄도 사용 가능
*/

 

• 중첩 주석

Swift는 중첩 주석을 지원

/*
 Swift는 중첩 주석을 지원함
 /*
 대부분의 프로그래밍 언어는 중첩 주석을 지원하지 않음
 // 여러 중첩 모두 가능
 */
 */

 

• 마크업 문법

변수, 함수, 메서드, 타입 등 작성 후 마크업 문법에 맞춰 주석을 작성하면, 퀵헬프 기능을 사용할 수 있다.

단축키: option(⌥) + command(⌘) + /

add 함수 추가 후 단축키를 눌러 주석을 추가한 경우 아래처럼 표시된다.

입력하기 전에는 <#~#> 으로 표시된다.

/// <#Description#>
/// - Parameters:
///   - a: <#a description#>
///   - b: <#b description#>
/// - Returns: <#description#>
func add(a: Int, b: Int) -> Int {
    return a+b
}

칸에 맞게 설명을 추가하면 아래처럼 표시된다.

/// 더하기
/// - Parameters:
///   - a: 더하기 할 숫자1
///   - b: 더하기 할 숫자1
/// - Returns: 더해진 값
func add(a: Int, b: Int) -> Int {
    return a+b
}