Dev_Dylan

[Xcode] Quick Help 사용하기 (주석 '///') 본문

iOS/iOS_Xcode

[Xcode] Quick Help 사용하기 (주석 '///')

Dylan_21 2023. 12. 22. 17:20

 

xcode에서 코드를 구현하다 보면 

inspector 3번째 탭에 있는 Quick Help를 참고할 때가 종종 있다.

 

`단축키 command + option + 3 `

 

혹은

Type에 `option + click` 을 사용하여 Summary를 띄우는 것 또한

Quick Help를 보는 것이다.

 

 

크게 6가지 항목이 있다.

 

- Summary : 요약

- Discussion : 어떤 동작을 하는 타입인지에 대해 설명

- Parameters : 파라미터에 대한 설명

- Important : 함수의 특수한 동작, 주의사항 및 구현 세부사항 등을 문서화한다.

- Authors : 코드의 작성자

- Version : 코드의 버전 정보 기록

 

사용방법

먼저, Quick Help를 사용하기 위해서 3중 슬래쉬 '///'를 써야 한다.

 

Summary

맨 첫째줄에 하이픈 '-'이 없으면 Summary로 만들어진다.

/// 맨위에는 Summary입니다.
///

 

Discussion

Summary에서 2번 이상 띄어 쓰고 다른 섹션(Parameters 등등..)을 사용하지 않는다면 Discussion으로 들어간다.

-(하이픈) 혹은 1. 넘버링도 가능하다.

/// 여기서 부터 Discussion
/// > 노트로 표시됨
/// 그냥 Discusion
///
/// 새로운 디스커션 혹은 줄 띄기를 하려면 위에 빈 공백을 주어야한다.

 

Parameters

파라미터에 대한 설명을 하는 섹션이다.

아래와 같이 Parameters는 대문자로 사용해야 한다.

파라미터에 대해서는 하이픈 뒤에 

/// - Parameters:
///   - a: 첫 번째 파라미터
///   - b: 두 번째 파라미터

 

Important

아래와 같이 - Important 양식을 사용하면 된다.

/// - Important:
///   메모리 Leak이 생길 수 있습니다.
///   사용 시 주의가 필요합니다.

 

 

Authors

/// - Authors:
///   Dylan-Yoon

 

 

Version

/// - Version:
///   3.5.3

 

 

함수 Quick Help

anyFunction이라는 함수를 만들어 간략하게 보이면 아래와 같다.

 

/// 이 함수는 예제 함수입니다. 이부분은 Summary
///
/// 여기서 부터 Discussion
/// > 노트로 표시됨
/// 그냥 Discusion
///
/// 새로운 디스커션 혹은 줄 띄기를 하려면 위에 빈 공백을 주어야한다.
/// - Parameters:
///   - a: 첫 번째 파라미터
///   - b: 두 번째 파라미터
/// - Returns: 어떤 리턴값 표시
///
/// - Important:
///   메모리 Leak이 생길 수 있습니다.
///   사용 시 주의가 필요합니다.
///
/// - Authors:
///   Dylan-Yoon
///
/// - Version:
///   3.5.3
func anyFunction(a: Int, b: Int) -> String {
    // 실행구문
    return "a And b"
}

 

아래와 같이 나오는 것을 볼 수 있다.

 

 

 

 

 

Class Quick Help

위에 있는 Quick Help구문과 똑같이 적용해도 다른 타입에도 사용할 수 있지만

return, Parameters와 같은 사용되지 않는 정보들은 표시되지 않는다.

 

 

Comments