형식을 맞추는 목적
"코드 형식은 매우 중요하다. 협업을 진행하는 개발자들은 코드 형식을 맞추기 위한 기준이 있어야 한다. 개발한 코드의 가독성은 앞으로 바뀔 코드의 품질에 매우 큰 영향을 끼치게 된다."
적절한 행 길이를 유지하라
"코드의 세로 길이와 가로 길이에 대한 적절한 기준이 필요하다."
Clean Code 책에서 말하길, FitNesse Project 파일 별 코드 세로 길이의 경우 평균 65줄이라고 한다. 다른 프로젝트들도 대다수 파일은 200줄 미만이었다. 이말은 즉슨 200줄 미만으로도 큰 시스템을 구축할 수 있다는 뜻이다.
또한, 비슷하고 연관된 개념은 수직 거리로 가까운 거리에 위치시키는 것이 좋다.
함수 호출 종속성 또한 마찬가지다. 소스 코드 모듈이 고차원에서 저차원으로 내려가는 것이 자연스럽게 읽히기도 좋다.
그렇다면 가로 길이는 얼마나 되는 것이 좋을까? Clean Code 책에서 조사한 프로젝트들의 평균 코드 가로 길이는 20 - 60자이다. 다만, 저자는 120자 정도로 행 길이를 제한한다고 한다.
연산자 우선순위를 강조하기 위해 공백을 사용한다. 예를 들어, 다음과 같다.
...
return (-b -Math.sqrt(determinant)) / (2*a);
...위 코드를 보면 곱셈은 우선순위가 가장 높으므로 붙여 쓰고, 그 보다 우선순위가 낮은 덧셈과 뺄셈은 띄워 쓰는 모습을 볼 수 있다.
간혹 코드 길이가 짧아 들여쓰기를 무시하고자 하는 경우가 생길 수 있다. 가령, 다음과 같다.
public String render() throws Exception { return ""; }하지만, 위와 같은 코드의 경우 코드를 읽을 때 무심코 지나칠 수 있다. 따라서 피하는 것을 권고한다.
때때로 비어 있는 반복문을 만나볼 수 있다. 이 경우 그러한 코드를 만들어 내지 않는 것이 가장 바람직하다고 볼 수 있으나, 어쩔 수 없는 경우 가독성을 위해 세미콜론을 아래에 붙여 준다. 아래와 같다.
while (dis.read(buf, 0, readBufferSize) != -1)
;팀 규칙
"팀은 코드를 작성하는 형식에 대해 한 가지 규칙으로 합의해야 한다. 그래야 개발된 소프트웨어가 일관된 스타일을 보인다. 추후 코드를 읽는 사람도 코드를 보다가 다른 파일을 보았을 때 그 코드 또한 동일한 스타일일 것이라는 것에 대한 신뢰를 줄 수 있다."
