[Clean Code(클린 코드)] 5장 형식 맞추기

 

본 게시글은 <Clean Code>를 학습한 내용을 정리한 글입니다. (문제시 삭제하겠습니다.)

 

Clean Code(클린 코드) - 교보문고

 

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀을로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.

형식을 맞추는 목적

• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
• 오랜 시간이 지나 원래 코드의 흔적을 더이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

적절한 행 길이를 유지하라

• 소스 코드는 얼마나 길어야 적당할까? 자바에서 파일 크기는 클래스 크기와 밀접하다. 대다수 자바 소스 파일은 크기가 어느정도 일까? 조사 결과(JUnit, FitNesse, testNG, Time and Money, Jdepend, Ant, Tomcat) 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있었다.
• 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
• 신문 기사처럼 작성하라
  • 소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
  • 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
• 개념은 빈 행으로 분리하라
  • 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
  • 패키지 선언부, import 문, 각 함수 사이에 빈 행이 들어간다. 너무도 간단한 규칙이지만 코드의 세로 레이아웃에 심오한 영향을 미친다.
  • 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다.
• 세로 밀집도
  • 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
  • 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
• 수직 거리
  • 서로 밀접한 개념은 세로로 가까이 둬야 한다.
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
  • 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
  • 변수 선언 - 변수는 사용하는 위치에 최대한 가까이 선언한다. 매우 짧은 함수의 경우 지역 변수는 각 함수 맨 처음에 선언한다. 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.
  • 인스턴스 변수 - 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 인스턴스 변수를 선언하는 위치는 아직도 논쟁이 분분하다. 중요한 건 변수 선언을 어디서 찾을지 모두가 알고 있어야 한다는 것. 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요
  • 종속 함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
  • 개념적 유사헝 - 친화도가 높을수록 코드를 가까이 배치한다. 명명법이 독같고 기본 기능이 유사하고 간단할수록 개념적인 친화도가 높다고 볼 수 있다. 서로가 서로를 호출하는 관계는 부차적인 요인이다.
• 세로 순서
  • 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

가로 형식 맞추기

• 한 행은 가로로 얼마나 길어야 적당할까? 앞서와 마찬가지로, 프로젝트 7개를 조사했다.
• 20자에서 60자 사이인 행이 총 행 수의 40%에 달한다. 10자 미만은 30% 정도로 보인다. 80자 이후부터는 행 수는 급격하게 감소한다. 프로그래머는 명백하게 짧은 행을 선호한다.
• 예전에는 오른쪽으로 스크롤할 필요가 절대로 없게 코드를 짰다. 하지만 요즘은 모니터가 아주 크고, 글꼴 크기를 왕창 줄여 200자까지도 한 화면에 들어간다. 개인적으로는 120자 정도로 행 길이를 제한한다.
• 가로 공백과 밀집도
  • 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
  • 할당 연산자를 강조하려고 앞뒤에 공백을 줬다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다.
  • 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문. 공백을 넣으면 한 개념이 아니라 별개로 보인다.
  • 연산자 우선순위를 강조하기 위해서도 공백을 사용한다. 수식을 읽기가 아주 편하다. → 불행히도, IDE 자동 형식 맞춰주는 도구는 대다수가 연산자 우선순위를 고려하지 못함
• 가로 정렬
  • 선언문과 할당문을 별도로 정렬하는 식의 가로 정렬은 별로 유용하지 못함
  • 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려짐
  • 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 감
  • 정렬이 필요할 정도로 목록이 길다면 분제는 목록 길이지 정렬 부족이 아니다.
• 들여쓰기
  • 소스 파일은 윤곽도(Outline)와 계층이 비슷하다.
  • 범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
  • 클래스 내 메서드는 클래스보다 한 수준 들여쓴다. 메서드 코드는 메서드 선언보다 한 수준 들여쓴다. 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.
  • 프로그래머는 이런 들여쓰기 체계에 크게 의존한다. 이 범위에서 저 범위로 재빨리 이동하기 쉬워진다.
  • 들여쓰기한 파일은 구조가 한 눈에 들어온다. 반면, 들여쓰기 하지 않은 코드는 열심히 분석하지 않는한 거의 불가해하다.
  • 들여쓰기 무시하기 - 때로는 간단한 f문, while 문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생김. 이런 유혹에 빠질 때마다 나는 항상 원점으로 돌아가 들여쓰기를 넣는다.

팀 규칙

• 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다.