[Clean Code] TIL - Day 10

Clean Code TIL Day 10

Day 10

🔖 오늘 읽은 범위 :  5장 형식 맞추기(p.96~p.116)

---

😃 책에서 기억하고 싶은 내용

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.(p.96)
• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.(p.96)
• 적절한 행 길이를 유지하라.(p.96)
• 소스파일도 신문기사와 비슷하게 작성한다. 일므은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.(p.98)
• 개념은 빈 행으로 분리하라.(p.98)
• 변수는 사용하는 위치에 최대한 가까이 선언한다.(p.101)
• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.(p.104)
• 친화도가 높을수록 코드를 가까이 배치한다.(p.106)
• 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.(p.106)
• 옛날 홀러리스가 내놓은 80자 제한은 다소 인위적이다. 100자나 120자에 달해도 나쁘지 않다. 하지만 그 이상은 솔직히 주의부족이다.(p.108)
• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.(p.108)
• 프로그래머는 이런 들여쓰기 체계에 크게 의존한다. 왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다.(p.111)
• 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다.(p.113)
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.(p.114)

🤔 오늘 읽은 소감과 떠오르는 생각

5장 형식 맞추기를 읽으면서 코드를 짤 때 사용하는 vs code의 extention인 code formatter 'Prettier'를 아주 유용하게 잘 사용하고 있다는 생각부터 먼저 들었다.

들여쓰기, 행 길이, 가로 공백 등등 5장에서 말한 형식 맞추기의 대부분의 내용에서 'Prettier'의 도움을 많이 받고 있었다. 작년에 팀 프로젝트에서 코드 형식을 맞출 때도 'Prettier'를 사용해 코드 규칙을 세운 부분도 있었다.

이런 형식 맞추기에 대해서는 기본적으로 해야 된다는 사실을 알고 있었지만 이런 도구를 활용해서 많은 도움을 받고 있었다는 것에 감사함을 느꼈고, 하지만 지나치게 도구에만 의존해서 이런 형식이 내 머릿속에서 잊혀지지 않도록 해야겠다.

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용

x

소감 3줄 요약

• 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하자.
• 'Prettier'에만 너무 의존하지 말자.