변수 작명법 정리

💡 좋은 개발자의 필수 교양인 변수 작명법에 대해서 정리해보자.

1. 대표적인 변수 작명법 종류 알아보기
2. 각 환경 별 적용 사례
3. 좋은 변수 작명 이론

---

📚 변수 작명법 종류

1. 카멜 표기법(Camel Case)

형식	첫 단어는 소문자, 이후 단어의 첫 글자는 대문자
유래	낙타(camel)의 혹처럼 단어가 연결될 때 중간 중간 대문자가 있는 모양에서 유래
의도	긴 변수명을 사용할 때 각 단어를 쉽게 구분할 수 있도록 함
장점	가독성이 좋고 Java, JavaScript, C# 등의 언어에서 표준으로 사용
단점	매우 긴 변수명은 여전히 읽기 어려울 수 있음
사용 예	userName, orderAmount, isLoggedIn, dailyUserTable

2. 파스칼 표기법(Pascal Case)

형식	모든 단어의 첫 글자가 대문자
유래	19세기 수학자 블레즈 파스칼의 이름에서 유래
의도	클래스나 타입명에 주로 사용되며, 변수명과 직관적으로 구분 가능.
장점	가독성이 좋고, 클래스나 객체를 명확히 구분할 수 있고, Typescript와 C#에서 많이 사용
단점	매우 긴 클래스명은 여전히 읽기 어려울 수 있음
사용 예	UserName, OrderAmount, IsLoggedIn

3. 스네이크 표기법(Snake Case), 팟홀 표기법(Pothole Case)

형식	모든 단어가 소문자로 연결되고 단어 사이에 언더스코어('_' ; 언더바) 사용
유래	언더스코어가 뱀의 형태를 닮아서 유래 (언더바 표기법이라고도 부름)
의도	모든 문자가 소문자이므로 대소문자 구분이 없는 환경에서 유용
장점	가독성이 좋고, 언더스코어로 단어를 명확히 구분 / C++에서 권장 / Linux의 GNU 프로젝트에서 사용
단점	변수명이 길어지면 타이핑이 불편할 수 있음
사용 예	user_name, order_amount, is_logged_in, daily_user_table

4. 케밥 표기법(Kebab Case)

형식	모든 단어가 소문자로 연결되고 단어 사이에 하이픈('-') 사용
유래	하이픈이 케밥의 꼬치 모양과 비슷하다는 것에서 유래
의도	변수의 각 단어 구분이 명확 / URL이나 CSS 클래스명에서 사용
장점	가독성이 좋고, 단어를 명확히 구분 / 중간 단어를 바꾸기 쉬움(더블 클릭으로 드래그)
단점	대부분의 프로그래밍 언어에서 변수명으로 사용 불가 : 하이픈이 연산자로 인식 / 전체 단어를 선택하기 불편 : 더블 클릭 시 단어 하나만 드래그 됨
사용 예	user-name, order-amount, is-logged-in

5. 헝가리안 표기법(Hungarian Case)

형식	접두사로 자료형을 붙힘
유래	마이크로소프트 개발자 중 헝가리 프로그래머가 쓰던 변수 명명법
의도	변수의 데이터 타입이나 사용 목적을 명확히 하여 코드 이해와 디버깅을 쉽게 하기 위함
장점	가독성이 좋고, 클래스나 객체를 명확히 구분할 수 있고, Typescript와 C#에서 많이 사용
단점	현재는 자료형을 쉽게 알아 볼수 있는 다양한 방법들(IDE 기능 등)이 많기 때문에 권장하지 않음
사용 예	strName: 문자열을 나타내는 변수 iCount: 정수를 나타내는 변수 fPrice: 실수를 나타내는 변수 bIsValid: 불리언 값을 나타내는 변수 pNext: 포인터를 나타내는 변수 (주로 C/C++에서 사용)

6. 상수(Constant)

• 거의 모든 방법에서 동일하게 대문자 + 스네이크 표기법으로 사용
• ex) DEFAULT_COUNTRY_CODE

7. 커스텀

• 개발사만의 또는 개발 조직 자체적으로 사용하는 방식 또한 많이 사용
• ex1) <접두사(2자리)>_<풀네임(단어)>_<약어>
  • 접두사 대문자, 단어의 첫글자 대문자, 약어 대문자
  • ST_User_CD
• ex2) C언어 자체의 권장 규칙이 존재
  • 함수는 동사 + 목적어 이고 완전한 단어를 사용
  • 구조체명은 _S 로 시작하고 단어의 시작은 대문자, 새로운 단어의 시작도 대문자 
• ex3) HTML / JS
  • 변수 뿐만 아니라, 파일과 폴더 이름 및 형식 규정
  • 모든 폴더는 index.html(혹은 .shtml, .asp)파일을 포함하도록 한다
  • ￭ 이미지 파일은 “/images/.” 폴더에 저장한다
    

---

🎨 각 환경에서의 변수 작명법 적용

현재 진행중인 프로젝트에서 마주할 수 있는 5가지 환경에서의 변수 작명법 적용 사례를 알아보자

1. Java (SpringBoot)

• 추천 작명법: 카멜 케이스, 파스칼 케이스
• 적용 예: userName, orderAmount / UserController, OrderService
• 기타: 메서드와 변수는 카멜 케이스, 클래스명은 파스칼 케이스

2. JavaScript/TypeScript (React)

• 추천 작명법: 카멜 케이스, 파스칼 케이스
• 적용 예: userName, orderAmount, UserProfile
• 기타: 함수나 변수는 카멜 케이스, 컴포넌트명이나 클래스명은 파스칼 케이스

3. Linux 명령어 및 스크립트

• 추천 작명법: 스네이크 케이스
• 적용 예: user_name, order_amount
• 기타: 환경 변수는 대문자와 언더스코어 사용 (USER_NAME)

4. GitHub Actions

• 추천 작명법: 스네이크 케이스
• 적용 예: user_name, order_amount
• 기타: YAML 파일의 특성상 스네이크 케이스가 가독성이 좋음

5. Dockerfile

• 추천 작명법: 스네이크 케이스
• 적용 예: user_name, order_amount
• 기타: 환경 변수와 비슷한 형식 (USER_NAME)

---

🎈 좋은 작명법의 간단 이론

목적

• 작명법을 사용하는 이유는 코드 일관성을 높혀 가독성을 늘리기 위함
• 변수나 클래스의 사용 목적, 파일의 형식을 직관적으로 알 수 있도록 작명해야 함
• 영단어를 주로 사용하기 때문에 단어의 뉘앙스를 고려해야 함

주의점

• 의미 없는 단어의 남용을 피하기
• 너무 길지 않도록 하기(IDE의 보조로 프로그래밍에 방해는 되지 않지만, 가독성이 떨어짐)
• 자료형 등 세부 정보를 포함하면 좋은 경우가 있음 (series_list 보다 series_set)
• 오해의 소지가 없도록 명확하게 표기
• 일관적으로 표기 (boolean 변수는 is, has, can, should, use 등을 붙이기)

하면 좋음

• 기억하기 쉬우면 좋음 (Simple Storage Service -> S3)
• 입력하기 쉬우면 좋음 (success -> ok)

---

💡 정리

• 작명법은 다양하지만 대중적인 것들만 알면 충분하고, 그룹에서 특별히 자체적인 방법을 사용할 수도 있음
• 중요한건 사용 할 때 일관성을 유지하는 것
• 특정 언어나 프레임워크에는 관례가 있으므로 간단히 조사해보고 사용하면 됨

 

레퍼런스

• https://blog.naver.com/nkind/222017581135
• https://yeop-blog.github.io/2017/09/29/2017-09-29-old-blog-post29/
• https://brunch.co.kr/@wapj2000/29
• ChatGPT3