좋은 변수명 짓는 원칙

 

좋은 변수명 짓는 원칙

많은 프로그래머들이 코드를 작성하는 것보다 변수명을 짓는 게 더 어렵다고 말한다.

변수명은 코드의 가독성을 좌우하고, 협업이나 나중에 자기가 코드를 읽을 때 "이게 뭐하는 변수였지?" 라는 혼란을 줄여준다.

 

 

좋은 변수명 원칙

1. 의도를 드러내기

• hp 보다는 playerHp
• t 보다는 elapsedTime
  └변수명만 보고도 무슨 역할인지 알수 있어야 한다.

 

 

2. 짧지만 명확하게

• 너무 길면 읽기 힘들고, 너무 짧으면 의미를 잃는다.
• count : 애매하다.
• enemyCount : 어떤 개수인지 명확해진다.

 

 

3. 일관성 유지하기

• camelCase ( playerHealth ) , PascalCase ( PlayerHealth ) , snake_case ( player_health )
  └이 중 하나로 통일하는 것이 좋다.
• 보통 C# 에서는 PascalCase ( 클래스 , 메서드 )
  └camelCase ( 변수 , 매개변수 ) 조합을 사용한다. 

 

 

4. 축약어 남발 금지

• 현실에서도 마찬가지지만 축약어 남발시 의미를 파악하기 어렵다.
• pH 보다는 playerHealth
• 단, 너무 자명한 건 허용한다 ( i = 반복문 인덱스 등 )

 

 

5. 도메인 언어 맞추기

게임이라면 BuffDuration , ManaPoint , SkillCooldown 같은 용어가 훨씬 더 자연스럽다.

현실과 매칭되는 단어를 사용 → 읽는 사람이 바로 이해 가능하다.

 

 

 

참고

• 불리언 ( bool ) 변수는 질문처럼 작성하면 좋다
  └ isAlive , hasKey , canAttack
• 리스트 / 배열은 복수형
  └ enemies , skills , players
• 상수는 대문자 + 언더바
  └ MAX_HEALTH , DEFAULT_SPEED

 

 

참고 자료

변수명 지어주는 사이트

https://var.gg/ko/variables