Page 79

3.1.2 바람직한 스타일의 기준 바람직한 코드 작성 스타일의 기준을 정확히 제시하기는 쉽지 않다. 시간이 갈수록 자신만의 선호하는 스타일이 생기고, 다른 사람이 작성한 코드를 보다가 좋은 스타일을 발견할 때도 있 기 때문이다. 게다가 정말 형편없이 작성된 코드를 직접 겪어봐야 어떻게 하면 안 되는지 확실 히 알 수 있기도 하다. 그럼에도 불구하고 잘 작성된 코드에서 볼 수 있는 공통적인 속성을 다 음과 같이 골라낼 수 있다. 이 장에서 하나씩 살펴보자. 문서화

분할

명명 규칙

언어 사용

포매팅

3.2 코드 문서화 프로그래밍에서 말하는 문서화 documentation 란 주로 소스 파일에 작성된 주석을 의미한다. 주석 은 여러분이 코드를 작성할 당시 가졌던 생각을 다른 이에게 전할 수 있는 좋은 기회다. 코드만 봐서는 뚜렷이 드러나지 않는 사항을 표현하기 좋다.

3.2.1 주석을 작성하는 이유 주석을 작성하면 좋다는 것은 알지만 그 이유를 진지하게 생각해본 적은 별로 없을 것이다. 주 석의 필요성을 제대로 파악하지 않은 채 그저 주석이란 마땅히 달아야 한다고만 알고 있는 프 로그래머도 많다. 주석을 작성해야 하는 이유는 다양하다. 이 장에서 하나씩 살펴보자.

1 사용법을 알려주는 주석 주석을 작성하는 한 가지 이유는 클라이언트에 코드를 사용하는 방법을 알려주기 위해서다. 일 반적으로 개발자는 함수의 이름, 리턴값의 타입, 매개변수의 이름 및 타입만 보고도 그 함수의 기능을 쉽게 파악할 수 있어야 한다. 하지만 모든 것을 코드만으로 표현할 수는 없다. 때로는 함 수를 호출하기 전과 후에 특정 조건을 만족해야 하는데, 이러한 사항은 주석 외에는 표현할 방법 이 없다. 함수가 던지는 익셉션도 주석에 남겨야 한다. 이때 꼭 필요한 정보만 주석에 남겨야 한 다. 함수에 주석을 달지 결정하는 것은 개발자의 몫이다. 경험이 풍부한 개발자는 이런 결정을

3장 코딩 스타일 147

Profile for 한빛미디어

전문가를 위한 C++ (개정4판) - 맛보기  

『전문가를 위한 C++』(개정4판)은 새로 추가된 기능과 관련 도구를 비롯해 C++에 대한 모든 내용을 코드와 솔루션 위주로 소개한다. 저자는 실전 프로그래밍에 적용할 수 있는 현실적인 기법을 다양하게 소개하였으며, 본 교재는 C++를 더 깊이 이해하...

전문가를 위한 C++ (개정4판) - 맛보기  

『전문가를 위한 C++』(개정4판)은 새로 추가된 기능과 관련 도구를 비롯해 C++에 대한 모든 내용을 코드와 솔루션 위주로 소개한다. 저자는 실전 프로그래밍에 적용할 수 있는 현실적인 기법을 다양하게 소개하였으며, 본 교재는 C++를 더 깊이 이해하...

Advertisement