변수, 상수명 잘 짓기

⭐️ 변수명, 상수명 또는 클래스 명 을 만들 때는 

제일 중요한 건 다른 사람이 코드를 볼 때 읽기 편하고, 이해하기 쉬워야 한다. ⭐️

 

 

이해하기 쉬운 코드를 위해서는 

1. 특정한 단어를 고르기 

2. 의미 없는 단어 피하기 

3. 이름은 얼마나 길어야 되는가?

 

 

SMART 한 방법으로 변수 이름 짓기 

 ▶️ easy to Search : 검색하기 쉽다

 ▶️ easy to Mix : 조합하기 쉽다

 ▶️ easy to Agree : 수긍하기 쉽다.

 ▶️ easy to Remember : 기억하기 쉽다.

 ▶️ easy to Type : 입력하기 쉽다.

 

 

 

 ▶️ easy to Search : 검색하기 쉽다

상위 카테고리의 이름을 앞에 붙인다. 

 

서버를 통해 데이터를 받을 때, 지연 시간 초과로 인한 에러에 대한 변수명을 짓는다면?

 

변경 전

• SERVER_TIMEOUT

 

변경 후 

• ERROR_SERVER_TIMEOUT

 

 ▶️ easy to Mix : 조합하기 쉽다

책에 대한 제목 변수를 짓을 때, bigest 보다는 title이 좀 더 어울린다.

 

변경 전

• var biggest_text: String = "제목"

 

변경 후 

• var title_text: String = "제목"

 

 

▶️ easy to Agree : 수긍하기 쉽다.

상황에 따라 달라지는 것이기 때문에 정답은 없지만, 

for 루프에서 index를 표현하고자 하는 변수에 index_of_for_loop 라고 긁어 부스럼이 

난 변수를 적을 필요 없다. 

 

 

 

▶️ easy to Remember : 기억하기 쉽다.

MVC는 model view controller의 약자이지만, 한 번 들은 사람은 거의 다 알고 있다.

기억하기 쉬운 것은 원래 알고 있는 거나, 비슷한 거나, 발음하기 편한게 도움이 된다. 

 

 

 ▶️ easy to Type : 입력하기 쉽다.

예를 들면 lambda, service, success 등이 작성하다 보면 잘 틀리는 단어들에 속한다.

그래서 최근에는 addrerss 보다는 addr 같이 말이다. 

 

 

---

https://brunch.co.kr/@wapj2000/29

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

 

https://medium.com/@jaykaybaek/%EC%A2%8B%EC%9D%80-%EB%B3%80%EC%88%98%EB%AA%85%EA%B3%BC-%ED%95%A8%EC%88%98%EB%AA%85-%EC%A7%93%EA%B8%B0-cfc519379f0a

좋은 변수명과 함수명 짓기