Xcode 코딩 중 주석기능, 마크업 활용하기

 

 

 

안녕하세요! 민군입니다. @_@... 

오늘은 Xcode상에서 코딩 중 유용하게 사용되는 간단한 주석 및 마크업 활용방법을 공유합니다! 주석이라 함은 코드가 많아지고 복잡해질 수록 으 빛을 발하는 법이죠. 주석이 없게되면 유지보수나 협업간에 큰 문제가 생길 수 있을 겁니다. 기본적인 사용방법 알아보겠습니다.

 

 

위와같이 MovieInfoTableViewController라는 Swift언어 상 클래스가 있습니다. 위 클래스의 간략한 설명을 주석으로 달아보겠습니다. 

단 한줄의 주석을 처리하는 방법은 //주석 방식으로 사용하시면 됩니다. 그럼 곧 바로 사용해보겠습니다.

 

 

 

 

// 영화정보  테이블뷰 컨트롤러 라고 주석을 설정하였습니다. 위처럼 주석으로 설정한 경우, 앱 실행중에 해당 주석코드는 작동하지 않습니다. 코드가 어떤용도로 사용되고 어떤 목적을 갖고 있는지 설명하는데 사용할 수 있게 되는 것 입니다. 

혹시 더 많은 줄로 설정을 적고 싶으신가요? 그렇다면  /* 주석 내용 */ 을 사용하시면 됩니다. 아래를 이어서 보겠습니다. 

 

 

 

 

위와 같이 /* */ 를 통해서 다수의 행에 주석처리를 할 수 있습니다. 주석표시 "//"을 일일히 치기 번거로우시다구요?

그렇다면 주석처리를 하고 싶은 영역에 커서를 두시거나 드래그 한 뒤 Command + "/"를 해보세요. 간단하게 주석처리를 하실 수 있습니다.

 

 

 

 

마크업도 보겠습니다. 마크업은 코드의 기능들을 주석으로 설명함과 동시에 좀더 기능구분이 가도록 해주는 장치인데요.

// MARK:- Properties

// MARK:- @IBOutlet Properties 가 보이시죠? 위처럼 주석을 작성하시면 코드 상단의 상태바의 상세코드 구분을 하실 수 있습니다.

 

 

 

 

 

코드 상단의 경로 바를 보시면 맨 우측에 해당 파일의 대략적인 프로퍼티와 메서드의 구조, 목록을 확인할 수 있는데요. 이 부분만 좀더 자세히 보겠습니다.

 

 

 

 

// MARK:- Properties

// MARK:- @IBOutlet Properties 

를 앞서 했었는데요. 마크업 설정을 한 프로퍼티와 일반프로퍼티와의 차이, 보이시나요? 실선과 볼드체효과가 있는것을 보실 수 있습니다.

 

마크업은 "MARK:-" 대신 "MARK:"로 사용할 수도 있어요.

MARK:를 사용하시면 위에 보이는 구분 실선 뺴고 해당 요소만 볼드체로 변경이 됩니다.

 

 

 

 

그렇다면 이번에는 

// MARK:- Properties

// MARK:- @IBOutlet Properties  대신

// MARK: Properties

// MARK: @IBOutlet Properties 를 사용하고, 다시 결과를 확인해보겠습니다.

 

 

 

 

 

위에서는 보이던 실선이 보이지 않습니다! 볼드체로만 변경이 되었지요. 마크업은 프로퍼티 변수나 메서드(초기화부, 델리게이트, 특정목적 메서드 등), 데이터등을 나누어 한눈에 보기 쉽게 만들 수 있습니다. MARK:, MARK:-의 사용법 알아봤는데 매우 간단했습니다.

 

지금까지 간략하게 Xcode 코딩 중 주석, 마크업 활용방법을 공유해보았습니다. 전반적으로 모두 굉장히 심플하게 사용이 가능했지요.

실제 현업에선 엄청난 코드가 우리를 반기게 될텐데요. 만약 이런 주석과 마크업을 제대로 활용하지 못한다면.. 지옥의 고통이 우리를 반길지 아무도 모릅니다 @_@;;

우리모두 깔끔하고 좋은 코딩을 하기위해 노력합시다! 그럼 모두들 즐코딩하세요 ^-^//