이름 지을때

본 포스팅은 계속 업데이트 할 예정입니다.

---

왜 이름을 잘 지어야 할까?

 

우선 염두해야 할 점은 내 코드는 분명 다른 사람이 보고 쓸 코드라는 점이다. 물론 나도 보고 쓰는 코드이고.

 

보통 개발을 하는 경우 메서드, 변수, 클래스를 한번만 사용하는 것이 아니기 때문에 나조차도 내가 만든 코드를 읽고 파악해야 하는 경우가 많다

 

이 과정에서 어떤 변수가 어떤 의미를 담았는지, 어떤 타입을 헷갈리게 된다면 개발하는 과정에서 매우 많은 문제점들이 생긴다.

(이 문제점들은 당신의 퇴근이나 프로젝트 마감에 영향을 미칠만큼 매우 강력하다!)

 

그렇기 때문에 중요한 것은

읽기 좋은 코드를 만들어야 한다는 것이다.

 

그럼 기초부터 시작해보자

---

아주 기본적인 것은

변수명은 첫번째 문자는 소문자

메서드는 첫번째 문자는 대문자 

 

언어 표기법은 다른 사람이 쓰는 것을 확인하면서 맞춰쓰기

카멜케이스 : helloWorld

파스칼케이스 : HelloWorld

스네이크케이스 : hello_world

케밥케이스 : Hello-World

 

 

 

---

 

 

 

기본적인 작성법을 제외하면

이 개념을 어떤 단어를 사용해서 표현을 해야하나 에 대한 문제가 남았다

 

우선 염두해야 할 점은 내 코드는 분명 다른 사람이 보고 쓸 코드라는 점이다. 물론 나도 보고

쓰는 코드이고.

 

보통 개발을 하는 경우 메서드, 변수, 클래스를 한번만 사용하는 것이 아니기 때문에 나조차도

내가 만든 코드를 읽고 파악해야 하는 경우가 많다

 

이 과정에서 어떤 변수가 어떤 의미를 담았는지, 어떤 타입을 헷갈리게 된다면 개발하는 

과정에서 매우 많은 애로사항이 생긴다

 

그렇기 때문에 중요한 것은

읽기 좋은 코드를 만들어야 한다는 것이다.

 

 

근본적인 질문

이 이름은 어떤 의미를 가져야 하는가?

 

특정 단어를 고르기

영어 단어를 보면 비슷하지만, 뉘앙스가 다른 단어가 있는 경우가 많다

의미를 잘 찾아보고 살려 지어야 한다.

또한 굳이 어려운 단어를 사용할 필요는 없다 나만 보는 코드가 아니라는 전제를 항상 깔고 가야한다

 

의미없는 단어 피하기

tmp, temp, result등 보편적인 의미를 지니는 이름을 이해하려면 전후상황을 다시 봐야한다.

이는 너무 많은 정보들이 생략되었기 때문이다 다른 단어를 사용하거나 전후 맥락을 알 수 있는

정보들이 포함된 단어를 선택해야 좀 더 좋은 이름이 될 것이다

 

이름은 정보를 담되 너무 많은 것을 담지 않도록.

이름 두어개 치면 줄이 넘어가는 등 가독성을 심하게 해치는 것은 지양해야 한다

 

 

변수명에 세부 정보를 덧붙여라

복수개의 요소에는 s를 붙인다거나 변수의 타입을 넣어주는 등

 

 

본 포스팅은

변수명을 잘 짓기 위한 몸부림

을 참고했습니다.