목적: 원활한 의사소통
적절한 행 길이 유지
- 파일의 길이가 짧게 유지되도록
- 첫부분: 고차원 개념과 알고리즘 설명 - 마지막: 저차원 함수와 세부 내역 (아래로 내려갈수록 세세하게 묘사)
- 개념 사이는 빈 행으로 구분 (새로운 개념을 시작한다는 시각적 개념)
- 밀접한 코드들끼리는 가까이 둔다 (주석이 끼면 멀어지므로 주의)
- 수직거리
- 변수 선언: 사용하는 위치에 최대한 가깝게
- 인스턴스 변수: 클래스 맨 처음에 선언
- 종속함수: 한 함수가 다른 함수를 호출하면 세로 가까이 (호출하는 함수 - 호출되는 함수 순서로)
- 개념적 유사성: 유사한 메서드끼리 가까이 둔다
가로 형식 맞추기
- 행 길이가 짧은 걸 대체로 선호
- 가로 공백과 밀집도
- 밀접한 개념은 붙여서, 요소가 나뉘는 지점은 띄워서 (ex. return (-b + Math.sqrt(determinant)) / (2*a) )
- 들여쓰기로 범위 구분
팀 규칙 따르기
- 팀에 속해 있을 땐 팀원끼리 규칙을 정하고 그걸 따르는 것이 최고
협업을 하기 위해서 가장 중요한 게 형식 맞추기가 아닐까..? 코드 작성 규칙을 정하고 그에 맞춰서 구현을 하면 가독성이 훨씬 좋아지는 게 보인다. 일할 때 린트 같은걸로 규칙을 강제하는 것도 좋았었다.
반응형
'books > clean code' 카테고리의 다른 글
7. 오류처리 (0) | 2023.12.14 |
---|---|
6. 객체와 자료구조 (0) | 2023.12.13 |
4. 주석 (2) | 2023.12.08 |
3. 함수 (1) | 2023.12.07 |
2. 의미있는 이름 (0) | 2023.12.05 |