Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
[TIL] Chapter 5. 형식 맞추기
#clean_code
2년 전
821


TIL (Today I Learned)

2022.02.28

오늘 읽은 범위

5장. 형식 맞추기

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

  • 코드 형식은 의사소통의 일환이다. 의사 소통은 전문 개발자의 일차적인 의무이다.

  • 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

  • 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.

  • 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.

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

  • 팀이 한 가지 규칙에 합의해야 한다는 부분에 크게 공감했다.

    Prettier를 사용한다면 들여쓰기 등 어느 정도 맞춰지지만 코드 사이에 빈 줄을 넣는 규칙 등 세세한 부분까지는 커버하지 못 한다. 예를 들어 React로 개발을 하는 경우 한 컴포넌트 안에서 다양한 훅을 사용할 시에 어떻게 그룹을 지어서 쓸지, import 하는 모듈들은 어떻게 묶을지, 비동기함수를 호출할 시 await는 한 줄 띄고 쓸지 안 띄고 쓸지 등 다양한 부분에서 개인의 취향이 있을 수 있다. 책에서도 나왔듯, 한 프로젝트여도 다양한 개발자가 참여를 한다면 이러한 부분들을 일관성 있게 보여주어야 "읽기 쉬운 문서"가 되기 때문에 eslint 를 커스텀해서 설정하는 등 팀 내에서 룰을 정하는 것이 바람직하다고 생각한다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

  • 자바를 많이 다뤄보지 않아서 잘 모르겠지만 한 클래스 안에서 같은 이름의 메서드가 존재하는 예시 (106페이지) 를 보고 '아무리 받는 인자가 다르다고 한들 같은 이름을 쓰면 헷갈리지 않을까..?' 라는 생각이 들었다.