[CleanCode] 형식 맞추기

CleanCode - 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 합니다.

코드 형식을 맞추기 위한 규칙을 정하고, 그 규칙을 따라야합니다.

(팀이라면 팀 모두가 합의하여 함께 정하자)

'코드 형식은 매우 중요하다'
코드 형식은 의사소통의 일환입니다.

그리고 가독성은 앞으로 유지보수하는 코드의 품질에 많은 영향을 끼친다.

책에서 원활한 소통을 장려하는 코드 형식이 몇 가지 있는데, 그 중 4가지만 정리해보겠습니다.

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

하나의 파일에 모든 내용을 담는 것 보다 작은 파일로 잘 유지하는 것이 좋습니다.

책의 예제에서는 대다수 프로젝트의 파일이 500줄을 넘지 않고도 큰 프로젝트를 유지할 수 있다는 사실을 말하고 있습니다..

엄격한 규칙이 아니지만 지키면 좋습니다. 보통은 큰 파일보다 작은 파일이 이해하기 쉽기 때문입니다.

2. 개념은 빈 행으로 분리하라.

대부분 코드는 왼쪽에서 오른쪽, 위에서 아래로 읽힙니다.
그러므로 생각 사이는 빈 행을 넣어 분리해야 합니다.

줄바꿈은 간단하지만 가독성에 많은 영향을 줄 수 있습니다.

3. 가로 형식 맞추기
한 행의 가로도 너무 길면 좋지 않습니다.
책의 예제에서는 대다수 프로젝트의 행 길이가 80자 이하가 좋다고 합니다.

마찬가지로 긴 행보다는 짧은 행을 선호합니다.

4. 팀 규칙

어떻게 보면 이 장에서 가장 중요한 내용 같습니다.

팀에서 함께 합의한 하나의 규칙을 만들고, 이것은 꼭 지켜야 한다는 내용입니다.

팀에서 정의한 팀규칙 (코딩 컨벤션) 이 아주 중요하다는 것은 팀원들과 함께 일해 본 사람이면

누구나 동의할 내용 인 것 같습니다.

 

최근에는 코딩 컨벤션이 많이 공유되어 좋은 형식들이 아주 많이 있습니다.
대표적으로 IntelliJ Code Convention 입니다.
https://www.jetbrains.com/help/idea/configuring-code-style.html

마무리
너무 당연한 이야기 일 수 있으나, '형식 맞추기'는 아주 기본적이고 중요한 내용입니다.

 

특히 코딩 컨벤션을 같이 만들고 지켜나가는 것이 가독성이나 유지보수 측면에서 좋다고 생각합니다.