Xcode Code Snippet Library를 통해 코드 문서화 쉽게 하기!

출처 : http://meetkei.com/wordpress/?p=1766

코드 작성만큼 중요한 코드 문서화는 개발자 자신과 인계받을 개발자를 위해 아주X1000000 중요한 작업이다.

Xcode에서는 Code Snippet Library를 통해 문서화를 손쉽게 할 수 있다.

 

우선 Code Snippet Library에 사용하고자 하는 주석들을 등록해야 한다.

1. 사용하고자 하는 주석을 작성한다. (아래의 예제는 Doxygen 스타일의 코드 주석)

/**

* @brief <#Description#>

* @param <#Parameter#>

* @return <#Return#>

* @remark <#Remark#>

* @see <#See#>

* @author Keun young Kim.

*/

<#….#>는 Xcode에서 인식가능한 placeholder로 탭을 통해 입력지점 사이를 이동할 수 있다. 필수 사항은 아니지만 placeholder를 넣어두면 아주 편리하다.

 

2.  Code Snippet Library 창을 연다. View > Utilities > Show Code Snippet Library 메뉴를 통해 열 수 있다.

 

3. 주석을 드래그해서 선택한 후 입력캐럿이 화살표로 변경될때까지 약 1초정도 마우스 왼쪽 버튼을 클릭한다. 화살표로 변경되고 나면 Code Snippet Library로 드래그 한다.

 

4. 필요한 속성들을 입력한다.

 

Title : 코드 조각의 이름

Summary : 요약설명

Platform : 적용 플랫폼 (All / iOS / Mac OSX)

Language : 적용 언어

Completion Shortcut : 입력에 사용할 자동완성 단축문자열

Completion Scopes : 적용 범위

 

- 사용법

Completion Shortcut 을 입력하지 않은 경우에는 사용할 코드조각을 Code Snippet Library에서 해당 소스코드로 드래그한다.

Completion Shortcut 을 입력한 경우에는 소스코드에서 해당 단축문자열을 입력하고 자동완성 목록에서 해당 코드조각을 선택하면 입력된다.

코드조각이 입력된 후 첫번째 placeholder로 포커스가 이동한다. 탭키를 통해 placeholder 사이를 이동할 수 있다.