[Clean Code] 5장 형식 맞추기

Clean Code 스터디 내용 정리; 5장 형식 맞추기

프로그래머라면 코드 형식을 맞추기 위한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 코드 형식은 의사소통의 일환이기에 너무도 중요하다. 코드는 바뀌고 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

이번 장에서는 원활한 소통을 돕는 코드 형식에 대해 다룬다.

1. 적절한 길이를 유지한다.

한 행은 120자 미만으로, 한 파일은 200줄 정도로 유지하도록 하자. 일반적으로 긴 것보다는 짧은 게 이해하기 쉽다.

2. 공백으로 개념을 분리한다.

가로 공백으로 별개의 개념이라는 것을 강조할 수 있고, 일련의 행 묶음을 빈 행으로 분리함으로써 완결된 생각을 분리할 수 있다. 들여쓰기 또한 범위로 이뤄진 계층을 표현하는 데에 사용되므로 짧고 간단한 블록이라고 해도 들여쓰기를 무시하지 않는 게 좋다.

3. 개념적 유사성에 따라 배치한다.

• 호출하는 함수와 호출되는 함수는 세로로 가까이 배치한다.
• 변수는 사용하는 위치에 최대한 가까이 선언한다. *
• 비슷한 동작을 동일한 명명법으로 수행하는 함수들은 가까이 위치시킨다.
• 서로 밀접한 코드 행은 세로로 가까이 놓는다.
  
  

* 변수 선언

짧은 함수의 지역변수는 각 함수 맨 처음에 선언. 루프 제어 변수는 루프문 내부에서 선언. 인스턴스 변수는 클래스의 맨 처음이든 마지막이든 잘 알려진 위치, 약속된 위치에 모아서 선언하여 변수 선언을 쉽게 찾을 수 있게 한다.

4. 신문 기사처럼 작성한다.

가장 중요한 개념, 고차원 개념을 가장 먼저 표현하고 개념을 표현할 때는 세세한 사항을 최대한 배제한 후, 아래로 내려갈수록 세세하게 묘사하여 마지막에는 가장 저차원 함수와 세부 내역이 나오도록 작성한다. 예를 들어, 호출되는 함수를 호출하는 함수보다 나중에 배치한다.

팀으로 일한다면 팀이 합의해 간단한 규칙을 정하고 모든 팀원이 그 규칙을 착실히 따라서 코드를 짜야 한다. 예를 들어 어디에 괄호를 넣을지, 들여쓰기는 몇 자로 할지, 클래스와 변수 그리고 메서드 이름은 어떻게 지을지 등을 결정한다.