함수 네이밍 관련 리뷰

0307kwon·2021년 2월 27일
1

코드리뷰

목록 보기
6/6

데이터를 검증하는 함수는 긍정형으로 짓기

isNotNumber() 보다
!isNumber() 나음.
메서드에 not이 포함되어 있으면 오히려 읽기 힘들다.

함수 이름은 함수가 하는 일의 '목적'을 추상화 시켜 정해야한다.

ex. "축하합니다! 게임이 모두 끝났습니다!"라는
메세지를 띄우는 함수의 이름은?
alertCelebration() (x)
alertGameEnd() (o)
=> 지금 메세지를 띄우는 목적은 게임이 끝났음을 알리는 것이므로
GameEnd가 더 적절하다.
=> 만약 메세지에서 '축하합니다!' 부분이 추후에 삭제된다면
Celebration이라는 네이밍은 의미를 잃어버리게 됨

ex. 어떤 버튼을 클릭하면 동영상을 검색하는 모달창이 뜬다
이때 네이밍으로는
handleSubmitButton() (x)
onModalOpen() (o)

  • 상세한 리뷰어 분의 리뷰

함수 네이밍은 일관성있게!

예를 들어
prefix,target, action 순으로 네이밍을 하면 함수를 파악하는데 도움이 된다.

example)

    const onModalClose() => {};
    //prefix : on
    //target : Modal
	//action : Close
profile
프론트 개발자를 꿈꾸는 학생입니다.

0개의 댓글