[iOS/Swift/Basic] 주석과 퀵헬프(Quick Help)

📌  이번 글은

Xcode에서 주석과 퀵헬프 사용 방법 입니다.

 

 

주석

- 주석 생성 단축키 : command[⌘] + /

 

한 줄 주석

// 한 줄 주석

 

여러 줄 주석

/*
 여러 줄 주석
 */

 

중첩 주석

/* 여러 줄 주석 안쪽에
 /* 여러 중첩 주석 가능
 // 한 줄도 가능
 */
 여기도 주석!
 */

 

문서화 주석

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

 

퀵헬프 (Quick Help)

- 코드 기능 설명서

- 퀵헬프 보는 방법 : option[⌥] + 원하는 코드 클릭 or command[⌘] + option[⌥] + [3]

- 퀵헬프 생성 단축키 : command[⌘] + option[⌥] + /

 

퀵헬프를 위한 마크업 예시

/// 오류 타입의 열거형
/// - noName: 이름이 없을 때 발생하는 오류
/// - incorrectGrade(grade: Int): 학년이 1학년 미만, 3학년 초과인 경우 잘못된 학년으로 인식하여 오류로 처리
/// - unknown: 알 수 없는 오류
enum ErrorStudentInfo: Error {
    case noName
    case incorrectGrade(grade: Int)
    case unknown
}

 

/**
 첫 줄은 Summary

 줄바꿈 : 텍스트 간의 한 줄을 비워놓기

 원형 글머리 기호 : '-' '+' '*'

 - 원형 글머리

 번호 글머리

 1. 1번

 텍스트 기울기 : *A pair of marks*

 텍스트 볼드 : **Two pair of marks**

 링크 : [Suni Blog](https://sunidev.tistory.com/)

 - note: 강조하고 싶은 메모 노트
 - author: 작성자
 - warning: 주의해야 할 점

 ---
 > 매개변수와 반환값 표기 하기
 - parameters:
     - studentName: 학생 이름
     - studentGrade: 학생 학년, 1 미만 또는 3을 초과 하면 오류 발생
 - Throws: 오류가 발생하면 ErrorStudentInfo의 한 케이스를 throw
 - returns: Success Save Student Info 정보
 */
func saveStudentInfo(studentName: String?, studentGrade grade: Int = 0) throws -> String {

    guard let name: String = studentName else {
        throw ErrorStudentInfo.noName
    }

    if grade > 3 {
        throw ErrorStudentInfo.incorrectGrade(grade: grade)
    }

    return "🟢 Success Save Student Info 🟢 name : \(name)." + (grade > 0 ? " grade : \(grade)." : "")
}

 

 

 

🙋🏻‍♀️ 참고

야곰, ⌜스위프트 프로그래밍: Swift5⌟, 한빛미디어(2019)