소개
처음에 이해하기 쉬운 변수의 이름을 사용하는 것으로, 코드를 보다읽이 쉽고, 이해하기 쉽게 할 수 있다고 하는 것은 이미 배웠습니다. 
//[1]
float pictureWidth, pictureHeight, pictureSurfaceArea;
pictureWidth = 8.0;
pictureHeight = 4.5;
pictureSurfaceArea = pictureWidth * pictureHeight;
현재는 몇줄 안되는 길이의 예제를 사용하고 있습니다만, 실제로는 더욱 긴 코드를 쓰게 됩니다. 프로그램을 쓸 때는, 실제로 당신이 어떤 것을 만들고 싶은 것일지를 생각할뿐만 아니라, 정확하게 문서화되고 있을지도 고려 할 필요가 있습니다. 잠시동안 프로그래밍으로부터 멀어진 뒤로 코드로 변경을 첨가하고 싶어졌을 때, 코드의 각 부분이 어떤 역할을 하고 있는지, 왜 이러한 차레로 코드가 나열해 있는 것는지를 재빠르게 상기시킬수 있기 때문에, 코멘트(코드 안의 주석)가 큰 힘이 됩니다. 우선은 코멘트부터 쓰기 시작하는 프로그래머조차 있는 정도입니다. 
 어쨌든, 당신의 코드에 코멘트를 써 넣는 작업에 얼마만큼의 시간을 할애하는 것을 강하게 추천합니다. 코멘트에 써버린 시간은 어차피 여러가지 형태로 만회할 수 있는 것을 보증합니다. 또, 당신의 코드를 다른 사람과 공유할 때, 당신이 제공하는 코멘트에 의해 그 사람은 재빠르게 당신의 코드가 이해가 갈 것입니다. 
 
주석달기
코멘트를 입력하기 위해서는, 두개의 슬래시(slash)를 코멘트의 문장의 머리에 둡니다. 
// 이것이 코멘트입니다
Xcode에서는 코멘트는 보통 녹색으로 표시됩니다. 만약 코멘트가 길게 여러행에 걸칠 때는 /* */의 사이에 둡니다. 
/* 이것이 복수행에 건너는 코멘트입니다. */

Outcommenting
여기서는 약간만 프로그램의 디버그에 대해서 설명합니다. Xcode는 디버그를 위한 훌륭한 기능을 가지고 있습니다. 디버그를 위한 낡은 방식의 하나에 outcommenting 이라고 부르는 방식이 있습니다. 당신의 코드의 일부를 /* */에서 둘러싸는 것으로, 그 부분의 기능을 일시적으로 무효로 한다 (주석처리한다) 수 있습니다. 문제가 있음직 한 부분을 무효로 하는 것으로 기타의 부분이 정확하게 동작하고 있는 것인가 아닌가를 확인할 수 있고, 버그의 장소를 찾을 수 있습니다. 만약 주석처리한 부분이 특정한 변수에 값을 대입하는 역할을 가지고 있을 경우등은, 변수에 적당한 값을 대입하는 일행을 일시적으로 추가하는 것으로, 코드의 나머지의 부분에 문제가 없을지 조사할 수 있습니다. 

왜 코멘트가 필요? 
코멘트의 중요성은 아무리 강조해도 지나치지 않습니다. 코드가 무엇을 가고 있는 것일지를 평범한 문장으로 쓰는 것도 유용합니다. 이것에 의해 코드가 무엇을 하고 있는 것일지 추측할 필요가 없어지고, 만약 그 부분으로 문제를 경험한 것이라면, 그 문제도 곧 파악할 수 있게 됩니다. 예를 들면 만약 무엇인가의 책에 설명되고 있는 특정한 수학적 기능을 사용하고 있을 경우, 관계가 있는 코드의 가까이 그 책의 참조를 두어야 하지요. 
 때로는, 실제의 코드를 쓰기 앞에 코멘트를 써버리는 것도 유익합니다. 코멘트를 쓰는 것으로 당신의 생각을 매듭지을 수 있고, 그 결과 코드도 보다간단한 것이 될 것입니다. 
 이 가이드의 예제 코드는, 본문내에 많은 설명이  있기 때문에, 평소 내가 쓰고 있는 것 같은 코멘트는 기입하지 않았습니다. 

원문 http://www.cocoalab.com/?q=node/8 

'become Xcoder' 카테고리의 다른 글

05:프로그램을 컴파일해서 실행  (0) 2011.06.21
04:화면에 표시하기  (0) 2011.06.21
03:함수  (0) 2011.06.21
02:노 코멘트(no comment)? 그것은 안됨!  (0) 2011.06.21
01:프로그램은 인스트럭션의 연속  (0) 2011.06.21
00:시작하기 앞에  (0) 2011.06.21
Posted by tklee

댓글을 달아 주세요