TIL 5장. 형식 맞추기 – 노마드 코더 Nomad Coders

프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
신문 기사처럼 작성하라
- 이름은 간단하면서도 설명이 가능하게 짓는다.
- 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
- 아래로 내려갈수록 의도를 세세하게 묘사한다.
- 마지막에는 가장 저차원함수와 세부 내역이 나온다.
신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다.
- 가장 주요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다.
- 세세한 사항은 가장 마지막에 표현한다.
- 그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.

연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도이다.
- 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
종속 함수. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.

공백과 밀집도
- 공백을 넣으면 한 개념이 아니라 별개로 보인다.
- 함수와 인수는 서로 밀집하기때문에 공백을 넣지 않는다.
- 강조하기 위해서도 공백이 사용된다.
들여쓰기 무시하기
- 간단한 if문, 짧은 while 문, 짧은 함수에서 들여쓰기 규칙을 무시하지 말고 들여쓰기를 사용하자.

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

짧은 while문이나 if 문 인 경우에는 대부분 들여쓰지 않고 그냥 사용하는 경우가 많았다. 그런데 들여쓰기를 한 경우와 안 한 경우를 비교해 보니 들여쓰기 규칙을 적용한 코드가 더 보기 좋았다.

팀 프로젝트를 하게 되다면 꼭 규칙을 정하고 그 규칙대로 지켜야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

오늘 읽은 다른사람의 TIL