CLOSE SEARCH
POSTS TAGGED WITH: Xcode

Xcode4 코드 문서화를 좀더 편리하게!!

코드 작성만큼 중요한 코드 문서화는 개발자 자신과 인계받을 개발자를 위해 아주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 사이를 이동할 수 있다.

[Objective C] Hello, World!

모든 프로그래밍의 첫 걸음인  Hello, World 출력 프로그램을 Objective C로 작성해 보자.


1. Xcode 실행

Xcode 아이콘이 Dock에 존재한다면 해당 아이콘을 선택하고, 없을 경우에는 파인더에서 응용프로그램 폴더에 있는 Xcode 아이콘을 선택하자.

자주 사용하는 아이콘이기 때문에 Dock으로  Drag & Drop 해두는게 편리하다.

Xcode를 실행하면 아래와 같은 창이 표시된다. 새로운 프로젝트를 만들어야 하므로 Create a new Xcode project 메뉴를 선택한다.



2. 프로젝트 템플릿 선택

New Project 대화창에는 상황에 따라 선택할 수 있는 다양한 프로젝트 템플릿이 존재한다.

Mac OS X 하위의 Application 항목을 선택하고, 오른쪽의 세부 항목에서 Command Line Tool을 선택하고 Type에서 Foundation 항목을 선택한다.



3. 프로젝트 이름 입력

프로젝트 이름 입력 창이 뜨면 적절한 이름을 입력한 다음 Save 버튼을 누른다.

프로젝트가 정상적으로 생성되면 아래와 같이 Xcode 프로젝트 창이 생성된다.



4. 소스 코드 작성

Xcode 화면의 가운데에 위치한 리스트에서 “프로젝트이름.m” 파일을 선택하면 아래쪽에 코드를 작성할 수 있는 편집창이 나온다.

아래의 보이는 코드는 Xcode가 기본적으로 생성한 코드이다.

NSLog(@”Hello, World!”);

NSLog()는 매개변수로 주어진 문자열을 콘솔창에 출력해 주는 함수이다.


일단 Xcode가 생성한 기본코드를 이용해 프로젝트를 빌드해 보자. Xcode에서는 이 단계를 Build and run이라고 한다.

Build 메뉴에서 Build를 선택하거나 Build and run을 선택하면 된다. Build and run의 경우 성공적으로 빌드를 마친 경우 프로그램을 자동으로 실행한다.

툴바에 있는 망치모양의 Build and Go 버튼을 선택해서 동일한 작업을 수행할 수 있다.


5. 프로그램 결과 확인

프로그램 내에서 NSLog() 함수를 이용해서 문자열을 출력하였으므로, 콘솔에 해당 문자열을 표시된다. 만약 Build and run을 실행했을때 콘솔 창이 보이지 않는다면 Run -> Console 메뉴를 선택하거나 shift + command + R 단축키를 이용해서 콘솔창을 표시할 수 있다.


프로그램이 정상적으로 실행된 경우에 위와 같이 Hello, World!문자열이 출력된 것을 확인할 수 있다.


크리에이티브 커먼즈 라이선스
이 저작물은 크리에이티브 커먼즈 저작자표시-비영리-변경금지 2.0 대한민국 라이선스에 따라 이용할 수 있습니다.