[CleanCode]형식 맞추기

코드 형식은 의사소통이다

프로젝트가 커질 수록 수많은 개발자들이 만든 클래스를 보게 될 텐데
개발자마다 고유의 스타일로 코드를 적어두었다면 상당히 읽기 힘들 겁니다.
그래서 개발초기에 tab의 크기와 font, 주석형식을 모두 정해두고 진행합니다.
그걸 일일히 검사할 수는 없으니까 sonarQube를 이용해 형식을 검사하면 형식에 맞지 않는 코드들을 찾을 수 있습니다.

---

적절한 행(세로) 길이
Lines

행길이

책에 따르면 우리가 많이 사용하는 tomcat 등 거대한 시스템도
클래스의 길이가 대개 200줄을 넘지 않는다.
작은 파일들로도 대규모 시스템을 만들 수 있다는 증거다.

---

가로 형식 맞추기

---

신문 기사처럼 작성하라

• 독자는 신문을 위에서 아래로 읽는다.
• 최상단에 가장 큰 표제가 간단한 설명이 적혀있다.
• 이름은 간단하면서도 설명가능해야 한다.
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

---

개념은 빈 행으로 분리

만약 이런 식으로 빈 행이 없다면 가독성이 상당히 떨어진다.

빈 행은 새로운 개념을 시작한다는 시각적 단서다.

---

세로 밀집도

이렇게 직접적이진 않더라도 관련있는 변수와 함수들의 경우는

가깝게 두어 한눈에 들어오게 한다.

---

수직 거리

위의 세로 밀집도처럼 서로 관련된 것들은 가깝게 두어야 한다.
좀 더 자세하게 알아보자.
 

변수 선언

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

아주 긴 함수인 경우에는 코드 중간에 변수를 선언하기도 한다.

 

인스턴스 변수

여기에서 인스턴스 함수란 new로 불러온 인스턴스를 말한다.

 

세로 순서

위→아래 방향으로 유지한다. 
그러면 소스코드 모듈이 고차원→저차원으로 자연스럽게 내려간다.

가장 중요한 개념을 표현할 때는 (고차원 함수를 말하는 듯)
세세한 사항을 최대한 배제한다. (함수를 작게 만들라는 뜻인 듯)

---

호출하는 함수를
호출한 함수보다 먼저 배치한다.

독자는 호출한 함수가 밑에 정의되리란 것을 알 수 있다.

---

가로 공백과 밀집도

이것 보다

이렇게 적절하게 띄어쓰기로 공백을 주면 가독성이 좋다.

 

연산자 우선순위를 고려하여 승수(-b)사이에는 공백을 두지 않고, 곱셈이 가장 우선이기 때문에 공백을 두지 않았다.

---

가로정렬

이러한 형식은 정작 중요한 부분을 강조하지 못하기 때문에 유용하지 못하다. 또한 형식이 변경될 가능성이 농후하다. 또한 이렇게 변수가 많이 사용될 시 따로 클래스로 분리해야 한다.

---

들여쓰기

어떠한 코드든 이렇게 들여쓰기가 없다면 읽기 쉽지 않을 것이다.

간혹 개발자들은 짧은 if / while문 등에서 들여쓰기 규칙을 무시하곤 한다.

하지만 이는 좋지 않으니 의식적으로 들여쓰기를 하는 것을 추천한다.

---

가짜 범위

지금까지 나는 while문 끝에 세미콜론; 하나를 살짝 덧붙인 코드로 수없이 골탕을 먹었다ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ네...이러지 말라는 거죠...

---

팀 규칙

처음 시작할 때 말했듯이 개발자 고유의 코딩스타일이 있기 때문에
프로젝트를 시작할 때

• 주석
• 들여쓰기
• 메서드 이름 형식

등을 미리 정하고 시작하고, 이를 우선으로 여겨야 한다.

---

밥 아저씨의 형식규칙

아주 잘 짜여진 코드 형식이 예제로 첨부되어 있는데
원본을 찾지 못해 깃헙에 누가 올려놓을 걸 첨부해본다..
https://github.com/ludwiggj/CleanCode/blob/master/src/clean/code/chapter05/CodeAnalyzer.java

CleanCode/src/clean/code/chapter05/CodeAnalyzer.java at master · ludwiggj/CleanCode