참고 포스트
Apple Developer Document, Markup Overview, (2022.01.24)


퀵헬프를 위한 마크업 코멘트 사용

  • 단축키 : ⌥+⌘+/
  • Editor > Structure > Add Documentation

Example 1

// MARK: - Quick Help를 위한 마크업 주석
/**
 퀵헬프 테스트를 위한 열거형
 - testCase: 테스트케이스
 - testCaseWithParam(param: Int): 정수형 파라미터를 입력 받는 테스트케이스
 */
enum QuickHelpTest {
    case testCase
    case testCaseWithParam(param: Int)
}

Example 2

/**
 퀵헬프 테스트를 위한 함수
 - Parameters:
 - name: 이름을 입력
 - age: 나이를 입력
 
 - Returns: 이름과 나이에 대한 String
 */
func helloQuickHelp(name: String, age: Int) -> String {
    return "My name is \(name), I'm \(age) years old."
}