노개북 2기 8일차
- 5장 형식 맞추기(pp.96~116)
요약 및 느낀 점
p.96
코드 형식은 중요하다! ... 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
그냥 돌아가기만 하는 코드가 아니라 형식에 맞는, 가독성이 좋은 코드를 쓰는 것이 장기적으로 훨씬 중요하다.
적절한 행 길이 유지하기
- 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
- 200줄 정도의 파일로도 커다란 시스템 구축이 가능하다.
- 신문 기사처럼 작성하기
- 위에서 아래로, 고차원 개념에서 세부사항이 나오는 흐름을 가지도록 작성
- 줄바꿈으로 개념 분리하기
- 연관성 있는 코드는 세로로 가까이 놓기
- 서로 밀접한 개념은 세로로 가까이 놓기
- 변수는 사용하는 위치에 최대한 가까이 선언하기
- 지역변수는 각 함수 맨 처음에 선언
- 인스턴스 변수는 클래스 맨 처음에 선언
- 종속 함수는 세로로 가까이 배치
- 호출하는 함수를 호출되는 함수보다 먼저 배치
- 개념적 유사성이 높을수록 코드를 가까이 배치
가로 형식 맞추기
- 100~120자 정도로 제한하는 것이 적당하다.
- 공백으로 개념의 빌집도 표현하기
- 가로 정렬은 유용하지 않음
- 들여쓰기는 범위를 계층으로 표현해주기에 아주 중요함
- 짧은 if/while문도 들여쓰기 할 것
팀 규칙
p.113
팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
현재 회사에서는 기본적으로 PSR을 따른다. 기본적으로 라고 한 이유는 레거시 코드에는 PSR을 따르지 않은 코드들이 많아서이다. 정확하게는 몰라도 아마 그 당시에는 특별히 정해진 규칙이 없었거나, 코드리뷰가 되지 않았거나, 또는 둘 다였을 것이다. 지금도 변수명에 카멜케이스와 스네이크 케이스가 뒤섞여있는 경우를 종종 본다. 특히 프론트단에 있는 자바스크립트 코드나, DB 컬럼 이름을 그대로 쓰는 경우에 그런 경향이 두드러진다. 이 부분은 처음 코드를 짤 때 PSR에 맞게 쓰고, 기존 코드는 수정해주면서 계속 신경써서 고치는 방법밖에 없는 것 같다.
더 공부할 내용
- PSR 다시 한 번 보면서 정리하고 규칙에 맞게 쓸 수 있도록 항상 신경쓸 것.
