Swift 주석 작성법

Swift의 주석은 다양한 markup을 제공하는데 velog 글 작성과 매우 유사한 부분이 많다.
markup을 적용한 주석은 Xcode 퀵헬프 기능을 통해 확인이 가능한데 그 종류를 정리해보자.

한줄 주석

// 슬래시 두개로 표현

여러 줄 주석

/*
여러 줄 주석은 슬래시 별표를 사용한다.
순서는 '슬래시 + 별', '내용', '별 + 슬래시'이다.
*/

제목 표시

#를 사용하면 새로운 문단의 타이틀을 설정할 수 있다.
또는 바로 다음줄에 등호를 사용해도 동일하다.

/*
	# heading title1
    heading title2
    =
*/

원형 글머리 기호

-, +, *를 사용하여 원형 글머리 기호를 사용할 수 있다.

/*
  - 모두 다 같은 형태의 글머리 기호를 갖는다.
  + 모두 다 같은 형태의 글머리 기호를 갖는다.
  * 모두 다 같은 형태의 글머리 기호를 갖는다.
*/

번호 글머리 기호

번호 글머리 기호는 숫자 + . 형태로 작성할 수 있는데 숫자의 순서는 자동으로 순서대로 정렬된다.

/*
  # 리스트1
	1. 번호 글머리 기호
	4. 순서가 바뀌어도 자동으로 변경된다
	2. 번호 순서는 의미가 없다
  # 리스트2
	3. 아이템1
	4. 아이템2
*/

수평선

-를 4개 이상 사용하거나 *를 개 이상 사용하면 긴 수평선이 나온다.

/*
  ----
  ***
*/

기울여쓰기, 굵게 쓰기

/*
	*기울여쓰기*
    __굵게 쓰기__
*/

코드 블럭

"`,(backquote)"를 4개 이상 사용하여 문단 앞뒤로 묶거나 4칸 이상 들여쓰기를 하면 코드 블럭이 만들어진다.

/*
  ````
  	let variable : String = "new value"
  ````
       let variable : String = "new value"
*/

함수의 매개변수 및 반환값 설명

함수의 매개변수, 반환값, throw 에러타입에 대해 작성도 가능하다

/*
	- parameters:
    	- param1 : 첫번째 paramter
        - param2 : 두번째 paramter
    - throws: 에러 타입 설명
    - returns: Boolean, true:뭐고 false:뭐다
*/

추가적인 키워드

정의된 키워드를 이용하면 부가적인 섹션이 생성되어 추가 정보를 작성할 수 있다. 제공하는 키워드는 다음과 같다.
Attention, Author, Authors, Bug, Complexity, Copyright, Custom Callout, Date, Example, Experiment, Important, Invariant, Note, Precondition, Postcondition, Remark, Requires, See Also, Since, Version, Warning

적용된 결과 한꺼번에 보기

---

더 상세한 기능은 애플 레퍼런스 문서에서 확인할 수 있다.