자바 변수 네이밍 컨벤션

 

 

1. 클래스(Class)

• PascalCase를 사용합니다. 즉, 각 단어의 첫 글자를 대문자로 작성합니다.
• 예: CustomerService, OrderRepository, ProductController

2. 메소드(Method)

• camelCase를 사용합니다. 메소드명은 동사로 시작하는 것이 권장되며, 첫 단어는 소문자로 시작하고 이후 단어의 첫 글자는 대문자로 씁니다.
• 예: findCustomerById, saveOrder, calculateTotalAmount

3. 변수(Variable)

• camelCase를 사용합니다. 변수명은 직관적이어야 하며, 무엇을 저장하는지 명확하게 알 수 있어야 합니다.
• 예: customerName, orderAmount, itemList

4. 상수(Constant)

• UPPER_SNAKE_CASE를 사용합니다. 모든 글자는 대문자로 표기하고, 단어 사이를 언더바(_)로 구분합니다.
• 예: MAX_RETRY_COUNT, DEFAULT_TIMEOUT, API_ENDPOINT

5. 이넘(Enum) 타입

• PascalCase를 사용하며, 이넘의 각 상수는 UPPER_SNAKE_CASE로 작성합니다.
• 클래스명: OrderStatus
• 이넘 상수: PENDING, SHIPPED, DELIVERED

6. 패키지명(Package)

• 소문자만 사용하며, 단어를 점(.)으로 구분합니다.
• 예: com.example.myapp, org.springframework.boot

 

---

자바에서 코딩 할때 Boolean 변수를 사용해야될때가 있습니다. Boolean

 

Boolean 변수 네이밍 기법:

1. is: 특정 상태를 나타낼 때 사용됩니다.
   • 예: isAvailable, isEnabled, isValid
   • 의미: 해당 객체나 값이 특정 상태에 있는지 여부를 표현합니다. 예를 들어, isValid는 값이 유효한지 여부를 나타냅니다.
2. has: 소유 여부를 나타낼 때 사용됩니다.
   • 예: hasPermission, hasChildren, hasErrors
   • 의미: 특정 속성이나 상태가 존재하는지 여부를 나타냅니다. 예를 들어, hasPermission은 사용자가 특정 권한을 가지고 있는지 확인합니다.
3. can: 능력이나 가능성을 나타낼 때 사용됩니다.
   • 예: canExecute, canRead, canFly
   • 의미: 어떤 행동을 수행할 수 있는지 여부를 나타냅니다. 예를 들어, canExecute는 특정 작업을 실행할 수 있는지를 나타냅니다.
4. should: 특정 조건이 충족되었는지 나타낼 때 사용됩니다.
   • 예: shouldUpdate, shouldSave
   • 의미: 특정 조건에서 해야 하는 동작을 설명합니다. 예를 들어, shouldUpdate는 업데이트가 필요한지 여부를 나타냅니다.

---

 

1. 명사(Noun)

• 변수나 객체를 나타낼 때 사용됩니다.
• 주로 데이터를 저장하는 변수 이름은 명사를 사용해, 그 변수의 역할과 데이터를 명확히 설명해야 합니다.
• 예: user, product, totalAmount
• 사용 예시: int totalAmount = 100;
  • 여기서 totalAmount는 금액이라는 구체적인 값을 나타내는 명사입니다.
• 이유: 변수는 특정한 데이터를 저장하는 역할을 하므로, 명사로 명확하게 그 목적을 설명합니다.

2. 동사(Verb)

• 메소드나 함수를 나타낼 때 사용됩니다. 동사는 함수가 수행하는 행동을 나타내므로 적합합니다.
• 메소드 이름은 주로 동사로 시작하며, 메소드가 수행하는 동작을 직관적으로 표현해야 합니다.
• 예: calculateTotal(), saveUser(), getData()
• 사용 예시: public void calculateTotal() { /* ... */ }
  • 여기서 calculate는 계산하다라는 동작을 표현하는 동사입니다.
• 이유: 메소드는 동작을 수행하므로, 동사를 사용하여 메소드의 기능을 명확하게 나타냅니다.

3. 형용사(Adjective)

• Boolean 변수와 같이 참/거짓을 나타내는 상태나 특성을 표현할 때 사용됩니다.
• 주로 상태나 속성을 나타내기 위해 형용사를 사용하거나, is, has 등의 접두사와 결합해 형용사 역할을 합니다.
• 예: isAvailable, isEnabled, isVisible
• 사용 예시: boolean isAvailable = true;
  • 여기서 available은 사용 가능한이라는 형용사입니다.
• 이유: Boolean 변수는 상태를 나타내므로 형용사나 상태를 나타내는 표현을 사용하는 것이 직관적입니다.

4. 혼합 기법

• 필요에 따라 명사와 동사를 함께 사용해 변수를 더욱 명확하게 표현할 수 있습니다.
• 예: customerList, orderAmount
  • customerList는 명사(customer)와 명사(list)를 결합해 고객 리스트라는 의미를 나타냅니다.
  • orderAmount는 주문 금액이라는 개념을 명확히 설명합니다.