TIL 3줄 요약
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어진다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야한다.
코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
TIL 날짜
2025.07.13
오늘 읽을 범위
- 형식 맞추기
책에서 기억하고 싶은 내용
형식을 맞추는 목적
- 코드의 형식은 중요하다. 전문 개발자의 일차원적인 의무는 '돌아가는 코드'가 아니라 의사소통이다.
- 오랜 시간이 지나 원래 코드의 흔적을 더이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
적절한 행 길이를 유지하라
- JUnit, FitNesse, testNG, Tomcat 등 프로젝트를 조사한 결과, 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
세로 순서
- 가장 중요한 개념을 가장 먼저 표현한다. 가장 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다. 세세한 사항은 가장 마지막에 표현한다. 그러면 독자가 소스파일에서 첫 함수 몇 개만 읽어도 개념을 파악하기 쉬워진다.
오늘 읽은 소감
의사 소통을 위한 규격을 맞추는 작업을 소홀히 했었다. 작업하며 필요에 따라 맞추거나 추가되는 코드를 보면서 일관되게 정리한 적이 있었는데, 작업자가 적을 경우 문제가 되지 않는다 생각했던거 같다. 5장 형식 맞추기를 읽고서 생각이 바뀌었다. 처음 잡아놓은 스타일이 계속 영향을 미친다는 사실을 인지하게 되었는데, 과거엔 기한내 결과물을 만들어 내는것이 중요하다고 느꼈다면, 지금은 완성도 있는 코드 퀄리티를 보장하며 결과물을 내놓는게 멋진거 같다. 로직 구현 보다는 초기 세팅에 품을 많이 들여야겠다.
계속해서 보완중