xcode에서 swift 주석 달기

우리가 개발을 하는것만큼 중요한것이 문서화입니다.

그렇지만 개발자는 굉장히 문서 작업을 하는것을 싫어하죠.

그래서 처음에 만들때 잘 정리를 해두면 나중에 만드는 문제가 발생하지 않겠죠.

그래서 주석을 추천드립니다. ㅎ

일반적인 사용법

1. 한줄주석
 
/// 나는 주석
var a = 10
 
2. 여러줄 주석
/**
 여러줄 주석
 - Parameters:
    - a: first parameter
 - Throws: Throws 원인
 - Returns: Return의 의미
*/
func example(a: String) throws -> Bool {
    // ...
    return true
}

조금 더 심오하게 사용해 봅시다.

죄송한 말씀을 먼저 드리면, 어디서 참고한것인데 링크를 찾지를 못하겠네요. 죄송합니다.

/**
 이제부터 주석을 한번 해보도록 합니다.
 
 줄바꿈은 상하를 한줄씩 띄워 놓도록 합니다.
 
 원형 글머리는 -, +  * 중 아무것을 사용합니다.
 - -로 출력
 + +로 출력
 * *로 출력
 
 번호 글머리 기호는 그냥 숫자를 넣어줍니다.
 1. 1번
 3. 2번 (자동으로 번호를 매겨주므로 퀵헬프에서는 3이 아니라 2)
 ----
 ↑ 마이너스(-)를 4개 이상 사용하면 줄이 들어갑니다.
 
 ---
 ↑ 바의 윗줄이 비어있을 경우에는 3개를 써도 동일하게 출력됩니다.
 
 *텍스트를 기울이고 싶으면 별표를 사용합니다.*
 
 **굵은 글자는 별표 두번으로 표시합니다.**
 
 링크를 넣어주는것도 좋은 방법같습니다. [Google](http://google.com)
 
 동호(===) 표시로 제목 출력하기
 ===
 
 # #으로 제목 출력하기
 
 바(---) 표시로 소제목 출력하기. 단, 바 바로 윗줄에 텍스트를 쓰지 않고 비워놓으면 일반 라인이 노출되므로 유의
 ---
 
 ## ##으로 소제목 출력하기
 
 `backquote를 이용하면 약간 색이 희미하게 표현이 됩니다.`
 
 ````
 4개 이상의 강세표(`)를 위아래에 넣으면
 그 사이의 내용은 코드 블럭으로 표시가 됩니다.
 ````
 
     네칸이상 들여쓰기를 하면
     여러 줄 코드를 코드블럭으로 표시가 됩니다.
 
 - note : 강조하고 싶은 메모 내용
 - author : 작성자
 
 ----
 
 < 그 외에 제공되는 키워드 >
 : Prrecondition, Postcondition, Requires, Invariant, Complexity, Important, Warning, Authors, Copyright, Date, SeeAlso, Since, Version, Attention, Bug, Experiment, Remark, Todo 등
 
 ----
 이 부분은 Description이 아닌 각각의 영역에 표시됩니다.
 * arg1,2는 "parameters"과 동일한 레벨에 쓰면 퀵헬프에 안나오므로 주의!
 * 반드시 "parameters"보다 우측으로 들여쓰기 해야 한다.
 - parameters:
    - arg1: 첫번째 파라매터 설명
    - arg2: 두번째 파라매터 설명
 - returns: 반환값 설명
 */
func test(arg1: String?, arg2: String?) -> String {
    return arg1! + arg2!
}
 

다들 화이팅. 깨끗한 소스를 위하여.