🔔 명명 규칙

코드의 일관성을 유지하고, 가독성을 높이기 위해 다음과 같은 네이밍 규칙을 따릅니다.

• 상수: CAPITAL_SNAKE_CASE
  • 예: API_KEY , DEFAULT_TIMEOUT
• 변수/함수: camelCase
  • 예: userName, getUserName()
• 클래스/인터페이스: PascalCase
  • 예: UserService, ProductController
• 패키지: 모든 문자를 소문자로 작성
  • 예: com.example.package

🖊 주석 작성

코드의 가독성을 높이고, 유지보수를 쉽게 하기 위해 주석을 적절히 작성합니다. 주석은 코드의 동작을 설명하고, 팀원들이 쉽게 이해할 수 있도록 명확하고 간결하게 작성합니다.

📌 메서드 주석

• 위치: 메서드 선언부 바로 위에 작성합니다.
• 목적: 메서드의 역할, 주요 기능, 입력 파라미터와 반환 값에 대해 설명합니다.
• 형식

/**
 * [메서드 설명]
 *
 * @param [parameter] - [파라미터 설명]
 * @return [반환값 설명]
 * @throws [예외] - [예외 발생 조건]
 */

• 예시

/**
 * 사용자의 아이디로 사용자 정보를 조회합니다.
 *
 * @param userId - 조회할 사용자의 고유 아이디
 * @return 조회된 사용자 정보 객체
 * @throws UserNotFoundException - 사용자가 존재하지 않는 경우
 */
public User getUserById(String userId) {
    // 로직 구현
}

📌 인라인 주석