2013년 3월 14일 목요일

신문 기사처럼 작성하라

신문 기사처럼 작성하라
Clean Code  (로버트 C. 마틴)

아주 좋은 신문 기사를 떠올려보라. 독자는 위에서 아래로 기사를 읽는다.  가장 상단에 기사를 몇 마디로 요약하는 표제가 나온다. 독자는 표제를 보고 기사를 읽을지 말지를 결정한다. 첫 문단은 전체 기사내용을 요약한다. 세사한 사실을 숨기고 커다란 그림을 보여준다. 쭉 읽으면서 내려가면 세세한 사실 (날짜, 이름, 발언, 주장, 기타 세부 사항)이 조금씩 드러난다.
소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명적으로 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
신문은 다양한 기사로 이뤄진다. 대다수 기사가 아주 짧지만, 어떤 기사는 조금 길다. 하지만 한 면을 채우는 기사는 거의 없다. 신문이 읽을 만한 이유가 여기에 있다. 신문이 사실, 날짜, 이름 등을 무작위로 뒤섞은 긴 기사 하나만 싣는다면 아무도 읽지 않으리라.

Copyright

Copyright ⓒ Elex.