TIL 5장 형식 맞추기

오늘 TIL 3줄 요약

• 규칙을 일관적으로 적용해야한다. 
• 비슷한 의미를 갖거나 내용이 이어지면 가까이 배치해야하고 간단하게 시작해서 자세한 내용으로 끝나야한다.
• 띄어쓰기, 들여쓰기, 함수 선언 위치, 변수 선언 위치 등을 고려해야 가독성이 좋은 코드를 작성할 수 있다.

TIL (Today I Learned)

2022.05.02

 

오늘 읽은 범위

5장. 형식 맞추기

 

책에서 기억하고 싶은 내용을 써보세요.

• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. (p.96)
• 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다. (p.97)
• 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다. (p.98)
• 세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다. (p.100~101)
• 변수 선언. 변수는 사용하는 위치에 최대한 가까이 선언한다. (p.101)
• 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다. 변수 선언을 어디서 찾을지 모두가 알고 있어야한다. (p.103)
• 종속 함수. 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. (p.104)
• 세세한 사항은 가장 마지막에 표현한다. 그러면 독자가 소스 파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다. (p.107)
• 할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. 공백을 넣으면 두 가지 요소가 확실히 나뉜다는 사실이 분명해진다. 반면, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다. 함수와 인수는 서로 밀접하기 때문이다. (p.108)

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

• 아직은 혼자서 처음부터 끝까지 커다란 코드를 작성해본 적이 손에 꼽는다. 이후에 커다란 코드를 짜게 될 때 이 내용을 잘 기억하고 빠르게 짜기보다 예쁘게 짤 수 있도록 노력해야겠다.
•  함수 선언을 할 때에 선언하는 위치는 크게 고려하지 않고 이게 필요하겠다하면 그 자리에 바로 코드를 작성하기 일쑤였는데 가독성이 좋은 코드를 위해 선언하는 위치도 고려해야겠다.
• 띄어쓰기도 코드를 읽고 의미를 파악하는데에 중요한 역할을 한다... 띄어쓰기를 남발하지말자.