Clean Code 작성법 정리

이샘미·2023년 1월 25일

일상

목록 보기
4/5

변수와 상수 네이밍
명사 혹은 형용사 형태로 짓기
EX) userData / isVaild (boolean값할 때)

함수와 메서드
동사 혹은 형용사 형태로 짓기
EX) sendData() : / inputIsVaild() :

클래스
명사 형태로 짓기
EX) class Client

: 구체적이고 명시적으로 짓기
이름만 보아도 무엇을 하는지 알 수 있게끔 짓기

주석
네이밍으로 표현할 수 없는 영역은 주석을 활용
관용적으로 쓰는 표현 :
TODO : 당장은 아니지만 다음에 해야할 일
EX) #TODO(이름) : for문 생성

FIXME : 치명적인 에러를 발생하는 코드는 아니지만 수정해야할 때
XXX : 더 생각할 필요가 있을 때

에러 핸들링 :
한 곳으로 모아서 에러를 처리하는 것이 좋다

참고 : 인프런 '모든 개발자의 실무를 위한 올인원 기본기 클래스'인강 정리

profile
가즈아

0개의 댓글