왜 나의 변수/함수명은 길까..?

요즘 부쩍 드는 나의 고민
나의 변수/함수명이 길다는 것
친절하게 의미를 전달하고 싶지만, 그렇다고 길면 싫어ㅠㅠ
어쩌면 좋을까?

아래의 책은 나의 고민을 해결해 줄 수 있을까?
한번 읽어나봅니다...

오픈소스 네이밍 특징들

https://brunch.co.kr/@goodvc78/12

위의 블로그는 자바를 대상으로 분석하였는데,
리액트 대상으로 하면 또 어떨지 궁금!

좋은 이름이 가진 특징

1. easy to Search
   • 고전적 범주화를 이용해 한 단계 상위 범주의 이름을 태그처럼 덧붙이면 됨
   • 참고) 고전적 범주화: 특정한 대상들을 묶어 상위 범주를 만들어 이해하는 것 (예: 소나무, 감나무 ... => 나무)

     에러 관련 상수값 네이밍 예시
     (bad) SERVER_TIMEOUT => (good) ERROR_SERVER_TIMEOUT
     *주의: 같은 접두어를 가진 함수/변수의 개수가 너무 많으면 안 붙이는 것만 못함

2. easy to Mix
   • 개발 언어의 문법과 조합해 이름 짓는 것이 좋음! (개발 언어 자체가 이미 이름에 대한 기본 체계를 가지고 있기 때문)
3. easy to Agree
   • 수긍할 수 있는 이름이란 누가 보더라도 그렇게 짓는 것이 더 낫다고 동의하는 이름
   • 일을 효율적으로 해야하는 것처럼, 이름 짓기도 효율적으로 해야함
   • 이름은 대상을 구별하기 위한 것임! (구별할 필요가 없는 것에까지 이름을 새로 지을 필요는 없음)
4. easy to Remember
5. easy to Type
   • 오탈자를 고려한 후 이름을 짓는 것이 좋음
   • 자주 사용되거나 중요한 이름이라면 입력하기 쉬운지, 오타를 낼 가능성이 작은지, 다른 사람에게 말로 전달하기 쉬운지 검토해 보는 것이 좋음

주석에 관하여

• 코드는 의미를, 주석은 의도를!

• 변수명/함수명은 주석을 달지 않아도 의미가 파악되도록 네이밍하자! (의미를 전달하기 위한 주석을 안달아도 되게끔!)

• 주석이 제 역할에만 충실하다면 많고 적고는 상관없음

• 일일이 의도를 함수에 포함할 수는 없음(코드 자체가 너무 지저분해지고, 가독성이 현저히 떨어짐)

• 코드에 표현하지 못한 어떤 의도를 전달해야할 때는 주석을 쓸 수밖에 없음

  개발자가 어떤 의도를 전달하는 이유
  * 다른 개발자들을 위해 코드를 왜 이렇게 작성했는지 설명하고 뜻밖의 발견을 제시하거나 새로운 아이디어를 보여주거나 어떤 방법이 더 좋은지 알려주는 것

• 그 주석이 언제 어떻게 읽히는지에 따라 반복해서 쓸 것인지를 결정해야 함

• 불피요한 주석은 없애고, 꼭 필요한 주석은 반드시 코드처럼 중요하게 관리해줘야 함!

Reference

• https://brunch.co.kr/@goodvc78/12
• http://www.yes24.com/Product/Goods/79378905?pid=123487&cosemkid=go15700131051712730&gclid=Cj0KCQiA37KbBhDgARIsAIzce14UUyVfc39fxpETIT7ykgyWO4JSXWfI2vWYQ-eHOigy4BHplweBCUgaAqGsEALw_wcB