다음의 포스트를 참고하여 작성하였습니다.
Apple Developer, Xcode Markup formatting, (2022.01.21)
Velog, Swift 주석 작성법, (2022.01.21)


주석이란?

Comment라고도 하며, 간단하게 프로그래밍 내용에 대한 메모라고 보면 된다. 주석은 프로그램을 이해하고 변경에 대한 내용을 제공하기 위해서 사용된다.

(주석은 컴파일러 혹은 인터프리터에 의해 무시가 되어 프로그램에 영향을 주지 않는다)


기본 주석

내가 처음 배운 주석은 ’//’ 슬래쉬 2개를 사용한 한 줄 주석이었다.

1) 한 줄 주석

(단축어: ⌘ + / )

// 한 줄 주석입니다

// 이렇게
// 여러줄을
// 쓰기도 합니다

2) 여러줄 주석

/* */

/*
여러 줄 주석
입니다
*/

/*
한 줄로 써도 됩니다
*/

3) 중첩 주석

/*
Swift는
/*
대부분의 다른 언어들과는 다르게
// 이렇게 중첩 주석을 지원합니다
*/
*/

마크업 주석(문서화)

Xcode의 Quick Help 기능을 사용하기 위해서는 일반 주석을 사용하면 안된다.

(Quick Help : Xcode에서 레퍼런스 문서의 요약된 내용을 보여주는 기능, 단축키 : ⌥ + 오른쪽 마우스 클릭)

Quick Help를 통해 객체나 함수를 명세하여 편하게 개발을 할 수 있도록 문서화할 수 있다.(jazzy등을 이용하여 따로 Html 문서화도 가능하다)


마크업 주석 자동생성

  • 단축키 : ⌥ + ⌘ + /
  • 마크업 주석에서는 한 줄 주석은 ’///’ 슬래쉬 3개를 사용하고, 여러 줄 주석은 ’/**’ 별 2개로 시작한다.
  • 상세 내용 : Apple Developer Documentation Xcode Markup

다음에 한 번 마크업 주석의 총 정리를 해봐야겠다.