Quick Help란?
다들 라이브러리를 사용하다가 Quick Help(퀵 헬프)를 사용해 본 적 있으시죠?
다들 사용하지만 용어를 몰라서 사용 안 해봤다는 분도 계실 텐데 아래의 사진처럼, Xcode에서 레퍼런스 문서의 요약된 내용을 보여주는 기능으로 option + 마우스 좌 클릭으로 봐왔던 것이 퀵 헬프입니다!
저는 퀵 헬프를 보면서 코드를 사용하는 방법을 쉽게 이해했기 때문에,
이번 포스팅에서는 협업할 때 제가 작성한 코드를 팀원들이 쉽게 사용할 수 있도록 퀵 헬프 주석을 만들어 보려고 합니다.
Quick Help 주석 작성하는 법
- 단축키
command+option+/
작성하려는 코드 위에서 단축키를 입력하면 위와 같이 자동으로 퀵 헬프 주석이 생성됩니다.
이름이 직관적이기 때문에 굳이 설명하지 않아도 어떤 내용을 넣어야 할지 다들 아시겠죠?
퀵 헬프 주석을 작성하고 사용하는 곳에서 option + 마우스 좌 클릭을 하면 아래와 같이 잘 정리된 주석을 볼 수 있습니다!
- 직접 만들기(여러줄 주석)
/**
...
...
*/
위와 같이 여러 줄 주석으로 직접 만들 수도 있습니다.
키워드
퀵 헬프 주석에 아래와 같이 여러 가지 키워드를 추가할 수 있습니다.
/// 퀵 헬프 샘플
/// - Parameters:
/// - params1: 파라미터
/// - params2: 파라미터
/// - Returns: 리턴
/// - Important: 중요
/// - Warning: 경고
/// - Version: 버전
/// - Authors: 작성자
/// - Note: 설명
/// - Tip: 팁
/// - Todo: 해야할 일
작성 팁
Description 부분에 마크다운을 사용할 수 있으니 적절하게 사용하시면 됩니다.
➕ 영역 구분 관련 주석
영역 구분 주석을 사용하면 아래와 같이 코드를 쉽게 파악할 수 있습니다.
// MARK: - <#Section Name#>
// TODO: - <#구현 내용#>
// FIXME: - 고쳐야 할 부분
// !!!: - 경고
// ???: - 의문점참고 자료
🍎 iOS Developer