노마드코더 북클럽 클린코드 TIL 다섯번째

2022년 5월 2일 TIL

오늘 TIL 3줄 요약

• 팀은 코드 형식을 맞추기 위한 규칙을 정하고 착실히 따라야 한다.
• 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
• 인스턴스 변수는 한곳에 모아두자.

오늘 읽은 범위

• 5장. 형식 맞추기

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

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다. (p.131)
• 어쩌면 돌아가는 코드가 전문 개발자의 일차적인 의무라 여길지도 모르겠다. 하지만 이 책을 읽으면서 생각이 바뀌었기 바란다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다. (p.131)
• 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다. (p.133)
• 서로 밀접한 개념은 세로로 가까이 둬야 한다. 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나다. (p.136)
• 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다. 변수 선언을 어디서 찾을 지 모두가 알고 있어야 한다. (p.138)
• 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되디라는 사실을 예측한다. (p.139)
• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다. (p.148)
• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다. (p.149)

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

• 어디서 부터 시작된건지 모르겠지만 지금까지 속했던 팀에서는 항상 팀 전체가 지키는 정해진 코딩 스탠다드 보다는 자신이 만드는 코드에 일관성만 있으면 된다는 식으로 많이 작업을 했던것 같다. 그래서 지금 프로젝트에도 _로 시작하는 멤버 변수나 함수, 심지어 카멜 케이스로 작성된 함수와 파스칼 케이스로 작성된 함수가 한 클래스에 섞여있기도 하고, 심지어 어떤 클래스는 작업자 마다 함수와 변수 정의 부분이 나눠져 있는 클래스까지 있다. 보통 모든 팀원이 동일한 IDE를 사용하기 때문에 확실히 코딩 스탠다드를 정해서 포맷팅 옵션을 모두가 공유해서 사용하는게 좋을 것 같은데 그렇게 잡혀있는 경우는 보지 못한것 같다.