요즘 부쩍 드는 나의 고민
나의 변수/함수명이 길다는 것
친절하게 의미를 전달하고 싶지만, 그렇다고 길면 싫어ㅠㅠ
어쩌면 좋을까?
아래의 책은 나의 고민을 해결해 줄 수 있을까?
한번 읽어나봅니다...
위의 블로그는 자바를 대상으로 분석하였는데,
리액트 대상으로 하면 또 어떨지 궁금!
에러 관련 상수값 네이밍 예시
(bad) SERVER_TIMEOUT => (good) ERROR_SERVER_TIMEOUT
*주의: 같은 접두어를 가진 함수/변수의 개수가 너무 많으면 안 붙이는 것만 못함
구별
하기 위한 것임! (구별할 필요가 없는 것에까지 이름을 새로 지을 필요는 없음)코드는 의미를, 주석은 의도
를!
변수명/함수명은 주석을 달지 않아도 의미가 파악되도록 네이밍하자! (의미를 전달하기 위한 주석을 안달아도 되게끔!)
주석이 제 역할에만 충실하다면 많고 적고는 상관없음
일일이 의도를 함수에 포함할 수는 없음(코드 자체가 너무 지저분해지고, 가독성이 현저히 떨어짐)
코드에 표현하지 못한 어떤 의도를 전달해야할 때는 주석을 쓸 수밖에 없음
개발자가 어떤 의도를 전달하는 이유
* 다른 개발자들을 위해 코드를왜
이렇게 작성했는지 설명하고 뜻밖의 발견을 제시하거나 새로운 아이디어를 보여주거나 어떤 방법이 더 좋은지 알려주는 것
그 주석이 언제 어떻게 읽히는지에 따라 반복해서 쓸 것인지를 결정해야 함
불피요한 주석은 없애고, 꼭 필요한 주석은 반드시 코드처럼 중요하게 관리해줘야 함!