Naming Convention

---

🏷️ Naming Convention이란?

정의

Naming Convention은 이름을 일정한 규칙에 맞게 짓는 방식이다.

이름 규칙은 코드와 문서의 의도를 빠르게 파악하는 데 중요하다.
프로젝트 안에서 일관된 규칙을 유지하면 가독성과 유지보수가 좋아진다.

⚙️ 왜 중요한가?

• 의미를 빠르게 파악할 수 있다.
• 팀 전체가 같은 기준으로 이해하기 쉽다.
• 코드 리뷰와 유지보수가 편해진다.
• 자동완성이나 검색 시에도 도움이 된다.

🧩 종류

종류	설명	예시
camelCase	첫 글자는 소문자, 다음 단어 첫 글자는 대문자	className
PascalCase	모든 단어 첫 글자는 대문자	ClassName
snake_case	단어를 밑줄로 구분	class_name
kebab-case	단어를 하이픈으로 구분	class-name
Hungarian	자료형 정보를 앞에 붙이는 방식	strClassName

🔍 사용할 때의 기준

• 언어와 프레임워크의 관례를 따른다.
• 팀 내에서 하나의 규칙을 정해 일관되게 사용한다.
• 변수, 함수, 클래스, 테스트 이름의 규칙을 따로 둘 수 있다.

🧪 예시

• 변수명: userName
• 클래스명: UserService
• 테스트명: shouldSaveUserWhenNameIsValid
• 파일명: user-name.md 또는 UserService.java

📌 정리

• 이름 규칙은 가독성과 유지보수에 영향을 준다.
• 프로젝트마다 일관된 규칙을 정해두는 것이 좋다.
• 언어와 도구의 관례를 함께 보는 것이 중요하다.

---

연결문서

• DSL
• TDD-Naming