우리가 어떤 글을 볼 때, 가독성이 좋다고 느끼는 경우가 있다. 그런 경우 대부분 글의 형식이 잘 갖춰져 있다는 전제가 성립된 채로 글이 작성되었기 때문이다.
소스 코드도 마찬가지로 일종의 글이기 때문에 형식을 잘 갖춰서 작성한다면 깨끗한 코드를 작성하는데 탄탄한 기반이 될 수 있을 것이다.
1. 형식을 맞추는 목적
오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
"사과를 너는 건내라 나에게" ❌
"나에게 사과를 주세요" ⭕️
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
2. 적절한 행 길이를 유지하라
200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
(예전에 야곰 리뷰어가 추천한 파일 길이는 기본 200줄 이내, 최대 250줄 이내)
3. 신문 기사처럼 작성하라
크게 요약된 내용에서 점차 상세 내용이 나오도록 작성하라
- 이름은 간단하면서도 설명이 가능하게 짓는다.
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
- 아래로 내려갈수록 의도를 세세하게 묘사한다.
- 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
4. 개념은 빈 행으로 분리하라
개념 사이는 빈 행을 넣어 분리하라
- 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
- 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
- 빈 행은 새로운 개념을 시작하는 시각적 단서이다.
5. 세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다.
🚫 Bad - (쓸데없는) 주석으로 밀접한 개념을 떨어뜨려놓은 코드
public class ReporterConfig {
/*
* 리포터 리스너의 클래스 이름
*/
private var className = String()
/*
* 리포터 리스너의 속성
*/
private var properties: [Property] = [Property]()
public func addProperty(property: Property) {
properties.append(property)
}
}👍 Correct
public class ReporterConfig {
private var className = String()
private var properties: [Property] = [Property]()
public func addProperty(property: Property) {
properties.append(property)
}
}6. 수직 거리
서로 밀접한 개념은 한 파일에 두고 세로 거리로 연관성을 표시한다.
함수의 동작 방식과 연관 관계를 살피다보면 소스 코드를 위아래로 뒤지게 된다. 이 작업은 꽤 많은 시간과 노력을 들이게 만든다. 이런 경우를 피하기 위해 밀접한 개념은 한 파일에 두는 것이 좋다.
또 그 중에서 서로 연관성이 깊은 함수끼리는 세로 거리를 가까이 두는게 좋다. 그렇지 않다면 함수를 찾기위해 코드를 위아래로 뒤져보아야하기 때문이다.
변수는 사용하는 위치에 최대한 가까이 두어야한다. 단, 함수가 짧을 경우 지역 변수는 함수 맨 위에 선언하도록 한다. 단 루프 변수(i, j, k)는 일반적으로 루프문 내부에서 선언하고 사용한다.
- 변수 선언: 변수는 사용하는 위치에 최대한 가까이 선언한다.
- 인스턴스 변수: 인스턴스 변수는 클래스 맨 처음에 선언한다.
- 종속 함수: 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
- 개념적 유사성: 개념적인 친화도가 높을수록 코드를 가까이 배치한다.
7. 세로 순서
- 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
func A() {
B()
}
func B() { ... }- 가장 중요한 개념을 가장 먼저 표현한다.
- 세세한 사항은 가장 마지막에 표현한다.
8. 가로 형식 맞추기
짧은 가로 길이를 사용하면서 역시 좋은 프로젝트들을 만들 수 있음
7개 프로젝트의 평균을 분석해보니 약 40% 정도가 20~60글자 사이를 갖고있다.
(저자는) 120자 정도의 행 길이를 제한한다.
9. 가로 공백과 밀집도
야곰에서 다 배움(컨벤션)
- 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 더욱 분명해진다.
var lineSize = line.count
- 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다.
recordWidestLine(lineSize)
- 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리한다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
lineWidthHistogram.addLine(lineSize, lineCount)
- 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
b*b - 4*a*c
10. 가로 정렬
어셈블리어 같은 가로 정렬은 엉뚱한 부분을 강조해서, 진짜 의도를 가릴 수가 있다.
public class FitNesseExpediter: ResponseSender {
private var socket: Socket
private var input: InputStream
private var output: OutputStream
private var requestProgress: Double
public func FitNesseExpediter(s: Socket,
context: FitNesseContext) throws {
socket = s
input = s.getInputStream()
output = s.getOutputStream()
requestProgress = 10000
}
}위와 같은 정렬은 별로 유용하지 못하다.
- 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려진다.
- 변수 유형은 무시하고 변수 이름부터 읽게 된다.
- 할당 연산자는 보이지 않고 오른쪽 피연산자에 눈이 간다.
선언문과 할당문은 별도로 정렬하지 않는다.
- 정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.
- 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
- 선언부가 길다면 클래스를 쪼개야 한다는 의미다.
11. 들여쓰기
- 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
- 들여쓰기가 없다면 코드를 읽기란 거의 불가능하다.
- 들여쓰기 무시하기: (저자는) 다음과 같이 한 행에 범위를 뭉뚱그린 코드를 피한다.
🚫 Bad
public class CommentWidget: TextWidget {
public func render() -> String { return "" }
}👍 Correct
public class CommentWidget: TextWidget {
public func render() -> String {
return ""
}
}12. 팀 규칙
온갖 스타일을 섞으면 나중에 골치가 아파진다. 팀에 속한 팀원들은 반드시 팀에서 정한 규칙에 따라 소스 코드를 작성해야한다.
- 팀은 한 가지 규칙에 합의해야 한다.
- 모든 팀원은 그 규칙을 따라야 한다.
🐒 요약
목적
코드 형식은 의사소통의 일환임. ‘돌아가는 코드'를 짜는 것이 우리의 목적이 아님. 다음 버전에서 기능은 바뀔 가능성이 매우 높지만, 스타일과 가독성 수준은 계속 영향을 미친다.
- 행길이 200줄 미만
- 신문 기사 처럼 작성하기
- 고차원 개념 → 저차원 개념
- 함수 호출 순서
- A A’ B B’
- 순서대로 읽을 수 있게
- 가로 형식
- 20-60자
- IDE의 무조건적인 코드 형식 맞추는 것이 막 좋지는 않다.
- 가로 정렬이 가독성이 떨어질 수도 있음
- 들여쓰기 무시하기
- if, while 문 같은 것 한 문장에 끝내고 싶긴한데, 이게 가독성에 부정적일 수 있음.
