코드 컨벤션

• 패키지명은 소문자로 작성

  • 예시: repository, raffle

• 클래스/인터페이스명은 파스칼 케이스로 작성

  • 예시: public class MemberService, public interface MemberService

• 변수/메서드는 카멜 케이스로 작성

  • 예시: int memberCount, getMemberId()

• 상수는 모든 문자 대문자, 단어 간 구분은 언더바( _ ) 사용

  • 예시: public static final int MAX_NUM = 999;

• Boolean의 경우 접두사로 is 붙이기

  • 예시: boolean isHuman, public Boolean isValidMember()

• 중괄호는 K&R 스타일 (한 줄 위에 열기)

  • 예시

  public void example() {
  	// ...
  }
  

• 띄어쓰기

  • 연산자 주위에 공백
    • 예시: int sum = a + b;
  • if, for 등의 키워드 뒤에 공백
    • 예시: if (condition) { ... }

• 주석

  • javadoc 주석 ( /** **/ )

    • 클래스, 메서드, 필드에 대한 설명에 사용

    /**
     * 사용자 정보를 반환합니다.
     * 
     * @param id 사용자 ID
     * @return 사용자 객체
     */
    public User getUserById(Long id) { ... }
    

  • 라인 주석 ( // )

    • 불분명한 로직 또는 주의가 필요한 부분 등에 사용

    // 사용자 정보를 DB에서 조회
    User user = userRepository.findById(id);
    

• 기타 권장 사항

  • 코드 길이가 너무 길어지지 않게 분리해서 작성

패키지 구조

계층형 구조