Naming Convention(네이밍 컨벤션) : 코드 네이밍 규칙과 좋은 네이밍 습관

💡 일반적으로 사용되는 네이밍 규칙

 

1. 카멜 케이스 (Camel Case)

• 첫 단어는 소문자로 시작하고, 이후 단어의 첫 글자는 대문자로 표기하는 방식.

• 예시: myVariableName, calculateTotalPrice

• 주로 변수명이나 메서드명에 사용됨.

 

2. 파스칼 케이스 (Pascal Case)

• 모든 단어의 첫 글자를 대문자로 표기하는 방식.

• 예시: CustomerName, ProductList

• 주로 클래스명이나 함수명에 사용됨.

 

3. 스네이크 케이스 (Snake Case)

• 단어 사이에 밑줄(_)을 사용하여 구분하는 방식.

• 예시: user_name, total_price

• 파이썬 변수명이나 데이터베이스 필드명에 자주 사용됨.

 

4. 대문자 스네이크 케이스 (Upper Snake Case)

• 모든 단어를 대문자로 표기하고, 밑줄로 연결하는 방식.

• 예시: MAX_LENGTH, DEFAULT_CONFIG

• 주로 상수명에 사용됨.

---

💡 언어별 네이밍 규칙 추천

 

• 자바: 카멜 케이스(변수, 메서드) / 파스칼 케이스(클래스)

• 파이썬: 스네이크 케이스(변수, 함수) / 파스칼 케이스(클래스)

• C#: 파스칼 케이스(클래스, 메서드) / 카멜 케이스(변수)

• 자바스크립트: 카멜 케이스(변수, 함수) / 파스칼 케이스(클래스)

 

---

💡 좋은 네이밍 습관

 

1. 의미 있는 이름을 사용하라: 변수나 함수의 이름은 그 목적을 명확히 나타내야 함.

    • 나쁜 예: a, temp

    • 좋은 예: userAge, calculateInterest

 

2. 약어 사용 자제: calculateTotalAmount() 대신 calcAmt() 같은 약어는 혼란을 유발할 수 있음.

 

3. 동사로 시작하는 함수명: 함수는 주로 동작을 나타내기 때문에 동사로 시작하는 것이 좋음.

    • 예시: getUserData(), updateProfile()

 

4. Boolean 변수는 긍정문으로: 불리언 변수는 is, has, can 같은 접두사를 사용하여 긍정적인 형태로 명명.

    • 예시: isLoggedIn, hasPermission

 

5. 클래스와 객체명은 명사로: 클래스를 정의할 때는 명사를 사용하여 그 개체를 나타내야 함.

    • 예시: User, Order

 

6. 파일 및 디렉터리 명명: 소문자 스네이크 케이스(snake_case)나 카멜 케이스를 사용할 수 있음.

    • 예시: user_profile.py, productList.js

 

7. 테스트 함수명: 테스트할 기능을 명확히 포함하도록 네이밍.

    • 예시: testUserLogin_success(), testInvalidInput_throwsError()

 

---

Naming Convention(네이밍 컨벤션)

: 코드의 식별자에 이름을 붙이는 방법들

 

 

변수 네이밍 규칙은 코드의 가독성과 유지보수성을 위한 것이다!!

네이밍 컨벤션은 팀의 합의에 따라 일관성을 유지하는 것이 가장 중요하다.

어떤 규칙을 선택하든 코드 전체에 동일하게 적용하는 것이 좋은 품질의 코드와 가까워지는 길일 것.