본문 바로가기
book

실무로 통하는 클린 코드, 클린 코딩을 위한 길라잡이, 한빛미디어

by 믹스 2024. 8. 24.

#2331

코딩을 하다 보면 항상 변수에 대해 고민하게 되는 경우가 있다. 최근 들어서야 Prettier, Stylelint 같은 것들이 꽤 잘 나와서 작업자들 간에 공통된 규칙을 가지고 코딩이 가능했지만, 이전에는 외워서 해야만 하는 경우가 허다했다. 세상이 좋아졌는데 문제는 이런 것들을 빠르게 도입하기 어려운 환경도 있고 권한을 가진 사람이 도입을 몰라서 못하는 경우도 있는데 실무자라면 꼭 한번 읽어보면 좋을 것 같다는 생각이 들었다.

개인적으로 7장 명명을 가장 재미있게 읽을 수 있었던 것 같다. 변수를 선언할 때마다 항상 어떤 식으로 정해야 할지 막막하다. 결국 한글을 번역기를 돌려가며 사용하곤 하는데 뭔가 이마저도 잘 와닫지 않는 경우가 허다했다.

  • 충분히 길며 모호하지 않고 설명이 포함된 명칭
  • 클래스명을 정확히 하고 책임을 세분화
  • my-객체 이름 변경
  • 단순히 result가 아닌 역할을 암시하는 이름 사용
  • 이름은 설명을 포함하며 충분히 길어야 하지만 너무 길지 않도록
  • 추상적인 이름을 구체적인 이름으로 변경
  • 맞춤법에 주의
  • 이름은 중복되지 않도록. 이름은 문맥에 맞고 지역적이어야 함
  • 클래스 명은 단수를 사용. 클래스는 개념을 나타내며 개념은 단수로 되어있음
  • 인수는 역할에 따라 지정
  • 이름에 불필요한 접두사나 접미사를 사용하지 말 것
  • 변수명을 data로 지정하지 말것

8장 주석은 개인적으로도 신경 쓰고 있던 부분이라서 공감되는 부분이 있었다.

  • 더 이상 사용하지 않는 주석 제거
  • 게터 주석 제거. 사소한 기능에 대한 주석은 불필요
  • 함수가 수행해야 하는 작업을 설명하는 경우 해당 주석을 함수명으로 포함시켜 주석을 제거
  • 메서드 내부 주석 제거

9장 표준은 코딩의 규칙을 위해 최근의 프로젝트들에서는 거의 다 Prettier로 기본 스타일을 통일시키고 있는 추세다.

  • 조직 전체가 동일한 표준을 따르고 시행할 것
  • 들여 쓰기의 표준화
  • 대소문자 규칙 통일

등등 책에는 다양한 규칙들이 망라되어 있다.

자동화를 시키는 과정에서 무언가 규칙을 정해 나가는 과정에서 필요한 것들에 대해 꽤 다양한 정보를 얻을 수 있을 것이라 기대된다.


한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다.


728x90
반응형

댓글