swift 주석(comments), 퀵헬프

주석(comments)을 왜 달까?

주석은 코드의 이해를 더 알기 쉽게 돕는다. 

 

주석은 여러가지가 존재한다. 

// 한줄 주석

 

/*
이렇게 하면 
여러줄의 주석을 만들 수 있다.
*/

 

 

 

마크업 문법을 활용해서 주석달기

단축키: command option / 

마크업 형식에 따라서 주석을 작성한다면 퀵헬프를 통해 내용을 확인할 수 있다. 

/// MARK: 나이 더하기
/// - Parameters:
///   - a: a의 나이
///   - b: b의 나이
/// - Returns: 둘 나이의 합
func add(a: Int, b: Int) -> Int {
    return a+b
}

 

퀵헬프란?

Xcode에서 레퍼런스 문서의 요약된 내용을 보여주는 기능을 말함

마우스를 원하는 항목에 위히한 다음 

option키를 누른 상태로 클릭하면 된다!

 

 

 

지금까지 한줄 주석을 주로 이용하여 코드를 작성하였는데 

앞으로 이렇게 코드의 이해도를 높이며 사용해봐야겠습니다!

 

 

https://trycoding.tistory.com/20

#02. Swift의 명명규칙과 마크업 문법을 활용한 문서화 주석

https://charmintern.tistory.com/41

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