🎆 Naming


Untitled

  1. 변수명은 누구나 알 수 있는 쉬운 단어를 선택한다.

    member, tutor…
    
  2. 변수는 CamelCase를 기본으로 한다.

    memberId, tutorId
    
  3. Endpoint, 파일 명 등 Resource 명은 kebab-case를 기본으로 한다.

    seb-be-41…
    
  4. 패키지, 디렉토리 명은 소문자를 사용한다.

    dto, entity…
    
  5. ENUM, 상수 는 대문자를 사용한다.

    FINAL_NUMBER = 1
    
  6. 메소드명은 소문자로 시작하고 동사로 작성한다.

    postMember
    
  7. 클래스명은 명사로 작성하고 UpperCamelCase를 사용한다.

    MemberDto
    
  8. 객체 이름을 메소드 이름에 중복해서 작성하지 않는다.

    class.getName() O / class.getClassName() X
    
  9. 컬렉션은 복수형을 사용하거나 컬렉션을 명시한다.

    List<User> users / List<User> userList
    
  10. 메소드명은 활용 의도를 명시하여 작성한다.

    searchName() X / getName() O
    
  11. 메소드명은 부가 기능을 설명한다.

    public Order getOrder(Order order) {
    	if (order == null) {
    		order = new Order(); 
    	}
    	return order;
    }
    
  12. LocalDateTime → xxxxAt 로 네이밍 한다.

  13. 객체를 조회하는 메소드는 findXXX 형식은 지양하고 Service Logic 게층에서는 getXXX을 사용한다.

⚙️ Structure


  1. 패키지는 목적별로 묶는다.