[Study][CleanCode - 2] 5. 형식 맞추기

📋 목차.

5. 형식 맞추기
    .적절한 행 길이를 유지하라
    .신문 기사처럼 작성하라
    .개념은 빈 행(줄 바꿈)으로 분리하라
    .세로 밀집도
    .수직 거리
    .변수 선언
    .인스턴스 변수
    .종속 함수
    .개념적 유사성
    .가로 형식 맞추기
    .가로 공백과 밀집도
    .들여쓰기 무시하기
    .팀 규칙

---

✔️ 내용.

 

5. 형식 맞추기

 

 코드 형식은 중요하다! 너무 중요해서 무시하기 어렵다.
너무 중요하기 때문에 융통성 없이 맹목적으로 따르면 안 된다. 코드 형식은 의사소통의 일환이다.
의사소통은 전문 개발자의 일차적인 의무다.

 어쩌면 '돌아가는 코드가'가 전문 개발자의 일차적인 의무라 여길지도 모르지만 책을 읽으며 생각이 바뀌었기를 바란다.

 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

 

---

 

.적절한 행 길이를 유지하라.

 

일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

 

---

 

.신문 기사처럼 작성하라

 

 독자는 위에서 아래로 기사를 읽는다 기사의 경우 최상단에 기사를 요약하는 '표제'가 나온다.
쭉 내려가면서 읽을수록 세세한 내용들이 나오게 된다.

 

 소스 파일도 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다.

이름만으로 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다.
마지막에는 가장 저 차원 함수와 세부 내역이 나온다.

---

.개념은 빈 행(줄 바꿈)으로 분리하라

 

 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이에는 빈 행을 넣어 분리해야 마땅하다.

 

 빈 행을 뺄 경우 코드 가독성이 현저하게 떨어져 좋지 않다. 단순 줄 바꿈 하나로 영역을 나눌 수 있다.

 

---

.세로 밀집도

 

 줄 바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.

 

// X
/**
 * 리포터 리스너의 클래스 이름
 */
private String m_className;

/**
 * 리포터 리스너의 속성
 */
private List<Property> m_properties = new ArrayList<Property>();


// O
private String m_className;
private List<Property> m_properties = new ArrayList<Property>();

 

---

.수직 거리

 

 시스템이 무엇을 하는지 이해하고 싶은데, 조각조각 어디에 있는지 찾고 기억하느라 시간과 노력을 소비한 경험이 있을 것이다.
 서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다.

 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도이다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스파일과 클래스를 여기저기 뒤지게 된다.

 

---

.변수 선언

 

 변수는 사용하는 위치에 최대한 가까이 선언한다.
우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.

루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

아주 드물지만 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.

 

---

.인스턴스 변수

 

 인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다.
잘 설계한 클래스는 많은(혹은 대다수) 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

 

---

.종속 함수

 

 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.

 

---

.개념적 유사성

 

 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.

 

 친화도가 높은 요인은 여러 기자이다.
앞서 보았듯이, 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예이며, 변수와 그 변수를 사용하는 함수도 한 예다. 그 외에도 AssertTrue, AssertFalse와 같이 비슷한 동작을 수행하는 일군의 함수가 좋은 예이다

---

.가로 형식 맞추기

 

 개인적으로 120자 정도의 행길이를 제한한다.

 

---

.가로 공백과 밀집도

 

 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
인수 사이에는 공백으로 별개로 보이게 한다.

 

---

.들여쓰기 무시하기

 

 때로는 간단한 if문, 짧은 while 문, 짧은 함수에서 들여 쓰기 규칙을 무시하고픈 유혹이 생긴다.
이럴 경우 원점으로 돌아가 들여 쓰기를 넣어 규칙을 유지한다.

 

---

.팀 규칙

 

 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜 대는 코드는 피해야 한다.

 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.

---

 

📝 느낀점.

- 각각의 형식을 맞추는 규칙에 대해 많이 알게 된 것 같다.
- 가장 크게 와닿은 부분으로 '팀 규칙'인데 결국 팀 내에 속해질 것이라면 팀 규칙을 따라야 하는 게 옳은 것 같다.
현재 개개인 따로국밥처럼 맘대로 짜고 있는 상황에 속해있기 때문에 가장 와닿았다...