코드 형식은 의사소통의 일환이다.
원활한 소통을 장려하는 코드 형식
- 적절한 행 길이를 유지하라.
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 성명하고 아래로 내려갈수록 의도를 세세하게 묘사한다.
- 생각의 사이에는 빈 행을 넣어 분리한다.
- 변수는 사용위치에 최대한 가까이 선언한다.
*단, 인스턴스 변수는 클래스 맨 처음에 선언하며 C++의 경우 모든 인스턴스 변수를 클래스 마지막에 선언하는 가위 규칙을 적용함
세로 형식: 서로 밀접한 코드들은 가까이에 놓여야 한다.
- 종속함수. 한 함수에서 호출하는 다른 함수는 바로 그 아래에 정의되어 있어야 한다.
이렇게 표현하면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.가로 형식: ~120자가 적당하다.
공백의 사용
- 할당 연산자 앞뒤로 공백을 주어 왼쪽 요소와 오른쪽 요소를 구분한다.
int lineSize = line.length();
- 함수 이름과 인수는 서로 밀접하므로 공백을 넣지 않는다.
private void measureLine(String line) {}
- 인수 사이에는 공백을 넣어 별개라는 사실을 강조한다.
lineWidthHistogram.addLine(lineSize, lineCount);
- 연산자 우선순위를 강조하기 위해 공백을 사용한다.
b*b - 4*a*c;
들 여 쓰 기
범위scope로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
프로그래머는 이런 들여쓰기 체계에 크게 의존한다. 들여쓰기가 없다면 인간이 코드를 읽기란 거의 불가능하리라.
팀 규칙
프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀규칙이다 !!!
반응형
'reviews > Clean Code' 카테고리의 다른 글
07. 오류 처리 (0) | 2021.01.21 |
---|---|
06. 객체와 자료 구조 (0) | 2021.01.21 |
04. 주석 (0) | 2021.01.19 |
03. 함수 (0) | 2021.01.18 |
02. 의미 있는 이름 (0) | 2021.01.18 |