39 lines (32 loc) · 1.64 KB

주석 규칙

코드만으로 이해하기 어려운 하드코딩, 예외 처리 부분에만 주석 작성
이미지 최적화 등 기술적 설명이 필요한 로직에 주석 필수
TODO 형식: // TODO #이슈번호 설명 (반드시 이슈번호 포함)

네이밍 규칙

모든 변수, 메서드명은 카멜케이스 사용 (validateCount, getCount)
불리언 변수는 is, has 접두사 사용 (isValid, hasPermission)
getBy...() 메서드는 반드시 findBy...()와 세트로 구현
findBy...()는 Optional 반환, getBy...()는 예외 던지는 구조로 작성

개행 규칙

클래스 정의문 다음에 반드시 빈 줄 추가
record는 첫 필드부터 바로 시작하되 필드 간 개행 필수
메서드 간에는 빈 줄로 구분

final 키워드 사용

변수나 매개변수에 기본적으로 final 사용하지 않음
의도가 명확히 불변임을 나타낼 때만 final 사용

코드 스타일

들여쓰기는 공백 4칸 사용
import 와일드카드는 499개 이상일 때만 허용
연속 들여쓰기 시 4칸씩 추가

var 사용 제한

Controller에서 Service 결과를 받을 때만 var 사용 허용
다른 곳에서는 명시적 타입 선언 필수

예외 처리

Optional을 사용하는 find 메서드와 예외를 던지는 get 메서드 패턴 준수
예외 메시지에는 관련 값 정보 포함 (예: "id: " + id)

코드 리뷰 포인트

null 체크 누락 여부 확인
하드코딩된 비밀번호나 API 키 금지
SQL 인젝션 취약점 체크
성능 저하를 불러일으킬 수 있는 로직 체크
코드 리뷰는 기본적으로 한국어 사용