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

보기 좋은 코드를 위해서는 형식을 깔끔하게 맞춰 코드를 짜야한다.

 

형식을 맞추는 목적

코드 형식은 중요하다! 

작동하는 코드가 제일 중요한 것이라고 여길 수 있지만 코드 작성 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미치기 때문에 상당히 중요하다.

 

 

적절한 행 길이를 유지하라

여러 자바 코드 프로젝트들을 보았을 때 충분히 작은 파일로도 커다란 시스템을 구축할 수 있음을 알 수 있다.

 

- 신문 기사처럼 작성하라

사람들이 신문을 읽을 때에 위에서 아래로 읽으며, 상단의 제목을 보고 기사를 읽을지 말지를 결정한다. 또한 신문은 여러 기사들로 이루어져 있고, 보통의 기사들의 길이는 짧다. 신문 기사들이 이러한 특징을 가지는 이유는 더 많은 사람들이 읽고 정보를 얻을 수 있도록 하는 목적이 있기 때문일 것이다. 코드도 그래야 한다.

 

- 개념은 빈 행으로 분리하라

꽉 압축하여 짜야진 코드는 읽기 어렵다. 빈 여백을 잘 활용하여 코드를 작성해서 읽기 쉽고, 체계적으로 정리된 코드를 만들어야 한다.

 

- 세로 밀집도

밀접한 코드는 가까이 놓여야 한다. 

 

- 수직 거리

• 연관성이 높은 코드는 세로로 가까운 위치에 있어야 한다. 
• 변수 선언 : 변수를 사용하고자 하는 곳 가장 가까운 곳에 선언해야 한다.
• 인스턴스 변수 : 변수끼리 거리를 두지 않고, 클래스 맨 처음에 선언해야 한다. 인스턴스 변수 선언 위치에 대해서는 논쟁이 있지만 모두가 잘 알 수 있는 곳에 위치시키면 되는 것이다.
• 종속 함수 : 호출하는 함수를 호출되는 함수보다 앞에 위치시키고, 두 함수를 가까이에 배치해야 한다.
• 개념적 유사성 : 호출 관계의 함수 또는 비슷한 역할을 하는 함수들은 가까이 배치해야 한다.

- 세로 순서

중요한 내용은 위쪽에 위치시켜서 고차원에서 저차원으로 자연스럽게 코드가 읽히도록 작성해야 한다.

 

 

가로 형식 맞추기

통계에 따르면 45자 정도가 한 행에 작성되는 경우가 일반적이며, 이는 짧은 행이 선호된다는 것을 입증한다.

저자는 120자 정도로 행 길이를 제한하는 것을 추천한다.

 

- 가로 공백과 밀집도

위에서 빈 행을 사용하여 코드를 읽기 쉽게 만들 수 있다는 말처럼 코드의 좌우 여백 또한 코드의 강조를 더하거나 읽기 쉽게 만들어준다. 특히, 연산자.

 

- 가로 정렬

가로 정렬에 집착해서는 안된다.

만약 코드의 길이가 길어서 정렬이 필요하다고 생각이 든다면, 클래스를 쪼개는 등의 코드를 수정하는 방법을 생각해 봐야 한다.

 

- 들여 쓰기

코드 사이의 계층 정보를 들여 쓰기를 사용해서 표현하는데 이는 파일 구조가 한눈에 들어오기 때문에 잘 활용하도록 한다.

들여 쓰기 무시하기 : if문 같은 것들을 한 줄로도 표현할 수 있지만 되도록이면 들여 쓰기와 공백을 넣어 코드를 작성해야 한다.

 

- 가짜 범위

행 구분을 위해 사용하는 세미콜론(;)을 헷갈리지 않도록 적절히 사용해야 한다.

 

 

팀 규칙

프로그래머로서 팀에 속해 있다면 팀에서 규칙을 정하여 일관적인 코드를 완성해야 한다.

 

 

밥 아저씨의 형식 규칙

저자가 본인이 사용하는 규칙들을 반영한 코드를 확인할 수 있는데 짧은 함수, 상단에 변수 정의, 연관된 함수끼리 가까운 위치에 배치, 적절한 공백 사용 등 내가 봐도 깔끔하고 보기 좋게 작성된 코드라는 생각을 할 수 있었다.

 

---

공백을 사용하는 것, 비슷한 함수끼리는 함께 가까운 위치에 배치하는 것 등은 평소에 신경 쓰던 부분들이었는데 다시 한번 중요성을 확인할 수 있었다. 그렇지만 그동안 주의하여 코드를 작성했다고 하더라도 아직은 클린 코드까지의 갈 길이 먼 것 같다. 

 

TIL 8회차