[Xcode] Xcode에서 quick help를 사용해보자

Xcode에서 option을 누른 채로 클릭을 하면,
해당 인스턴스, 프로퍼티, 메서드에 대한 정보를 얻을 수 있다.

아래와 같은 창을 Quick help(주석 설명)이라 하는데, 이거를 직접 만들려면 어떻게 해야 하는지 방법을 알아보자.

기본은 /** */ 기호를 사이에 내용을 추가해주는 방식으로 사용한다.

위치는 Quick help를 표시하고 싶은 곳 바로 위에 작성하면 된다.
(클래스를 정의하려면 클래스 바로 위에, 클래스 내 메서드를 정의하려면 클래스 내 메서드 바로 위에)

이렇게 정의하면,

이렇게 보이게 된다!

이때, Summary는 가장 상단에서 해당 내용을 요약하는 글을 작성하는 부분

Declaration은 프로퍼티나 메서드의 정의 부분을 보여주는 부분

Discussion은 자세하게 내용을 서술한 부분

Parameters는 매개변수의 내용을 보여주는 부분

Declared In은 어느 파일에 정의되어 있는지를 보여주는 부분이다!

 

💡Reference

Markup Formatting Reference: Formatting Quick Help

[xcode] quick help (주석 설명) 사용 방법