[클린코드] 5. 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
형식을 맞추는 목적
코드 형식은 중요하다! 너무 중요해서 무시하기 어렵다. 너무나도 중요하므로 융통성 없이 맹목적으로 따르면 안 된다.
코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
오늘 구현한 기능은 다음 버전에서 바뀔 확률을 매우 높기 때문에 가동성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
그렇다면 원활한 소통을 장려하는 코드 형식은 무엇일까?
적절한 행 길이를 유지하라
JUnit, FitNesses, Time and Money, JDepend, Ant, Tomcat 프로젝트의 평균 파일 크기는 약 65줄이다.
가장 긴 파일은 약 400줄이고 가장 짧은 파일은 6줄이다.
이는 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 의미이다.
일반적으로 큰 파일보다 작은 파일이 이해하기가 더 쉽다.
반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다.
신문 기사처럼 작성하라
신문은 다양한 기사로 이뤄진다. 대다수 가사가 아주 짧다. 한 면을 채우는 기사는 거의 없다.
소스 파일도 신문 기사와 비슷하게 작성한다.
- 이름은 간단하면서도 설명이 가능하게 지어야 한다.
- 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
- 아래로 내려갈수록 의도를 세세하게 묘사한다.
- 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
무작위로 뒤 섞이고 내용이 너무 긴 기사는 아무도 읽지 않으리라.
개념은 빈 행으로 분리하라.
거의 모든 코드는 왼쪽에서 오른쪽으로, 그리고 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이에는 빈 행을 넣어 분리해야 마땅하다.
빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다은 줄에 눈길이 멈춘다.
반대로 서로 밀집한 코드 행은 세로로 가까이 놓아야 한다.
수직 거리
시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조작이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
여기서 연관성이랑 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
작은 함수의 지역변수는 맨 처음에, 루프를 제어하는 변수는 루프 문 내부에 선언하는 것 처럼 사용하는 곳 제일 가까운 곳에 선언한다.
인스턴스 변수
인스턴스 변수는 일반적으로 C++에서는 마지막에, 자바에서는 맨 처음에 변수를 선언한다.
중요한 것은 한곳에 인스턴스 변수를 모은다는 것이다.
종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
첫째 함수에서 가장 먼저 호출회는 함수가 바로 아래 정의된다. 다음으로 호출하는 함수는 그 아래 정의된다.
그러므로 호출되는 함수를 찾기가 쉬워지며, 그 만큼 모듈 전체의 가독성도 높아진다.
개념적 유사성
개념적인 친화도가 높은 코드는 서로 끌어당기기 때문에 친화도가 높을수록 코드를 가까이 배치한다.
한 한수가 다름 함수를 호출하거나, 변수와 그 변수를 사용하는 함수가 한 예다.
가로 형식 맞추기
프로그래머는 명백하게 짧은 행을 선호하기 때문에 코드를 작성할때는 짧은 행이 바람직하다.
개인적으로는 120자 정도로 행의 길이를 제한한다.
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
밀접한 개념은 띄어쓰기를 하지 않고, 느슨한 개념은 띄어쓰기를 하기도 한다.
연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
하지만 공백을 넣어줘도 나중에 도구에 의해서 자동적으로 없어지는 경우가 흔하다.
가로 정렬
특정 구조를 강조할때는 가로 정렬을 사용하기도 한다. Tab으로 변수명 마다 가로 정렬을 맞추는 것을 예로 들수있다.
하지만 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문에 별로 유용하지 못하다.
정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이이지 정렬 부족이 아니다.
선언부가 길다면 클래스를 쪼개는 방법이 훨씬 유용하다.
들여쓰기
범위로 이뤄진 계층구조를 표현하기 위해 코드를 들여쓴다.
프로그래머는 들여쓰기 체계에 의존한다. 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현할 수 있다.
들여쓰기가 없다면 인간이 코드를 읽기란 쉽지 않다.
팀 규칙
프로그래머라면 각자 선호하는 규칙이 있다.
하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 그리고 모든 팀원은 그 규칙에 합의해야 한다.
개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.
스타일은 일관적이고 매끄러워야 한다. 한 소스파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.
온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피해햐 한다.