[iOS - swift] 주석 처리, 퀵 헬프 주석, //, ///

일반 주석 vs 퀵 헬프 주석

• 일반 주석: //

• 퀵 헬프 주석: ///

퀵 헬프

• Xcode에서 레퍼런스 문서의 요약된 내용을 보여주는 기능
• option + 왼쪽 마우스 클릭

• cmd + option + 3

퀵 헬프에 사용되는 주석

• /// 사용
• 단축키: cmd + option + /

/// 해당 클래스는 예제 클래스
class MyClass {
    let myProperty: Int

    init(myProperty: Int) {
        self.myProperty = myProperty
    }
}

• 사용하는쪽에서 주석 확인

• description삽입: > 사용

/**
 (해당 부분은 summary) 해당 클래스는 예제 클래스
 > (해당 부분은 description)
 */
class MyClass {
    let myProperty: Int

    init(myProperty: Int) {
        self.myProperty = myProperty
    }
}

let testClass = MyClass(myProperty: 1)

• paramters 정보: paramters: 키워드 사용

    /**
     (서머리 부분)
     > (디스크립션 부분)
     - Parameters:
        - property: 나의 프로퍼티
    */
    func printProperty(property: Int) {
        print(property)
    }

마크업 문법

• 줄바꿈: 텍스트 간에 한줄 비우기
• 문단 바꿈: 바를 세 개 이상 사용
• 텍스트 기울이기: *[텍스트]*
• bold: **[텍스트]**
• link: [링크 이름](링크 주소)
• 큰 제목: # [제목]
• 중간 제목: ## [중간 제목]
• 코드블록: backquote사용 ``` [코드] ```

* 참고

https://charmintern.tistory.com/41