Skip to content

백엔드 코딩 컨벤션

jaeseongDev edited this page Jul 21, 2021 · 3 revisions

IntelliJ Foramtting 기능

  • Google IntelliJ Java Format 적용
  • 단, 들여쓰기는 4칸으로 수정
  • Hard wrap at(한 줄에 들어가는 코드의 길이)은 125로 설정

클래스에서 필드 선언 시 공백 관련 컨벤션

  • 클래스 내에 필드 사이에 공백 1줄을 추가해야 한다.
  • 단, 상수끼리는 필드 사이에 공백 1줄을 추가하지 않고, 동시에 붙여서 작성한다.
private static final int ONE = 1;
private static final int TWO = 1;
private static final int THREE = 1;

private String id;

private String url;

@JsonProperty("kakao_account")
private String email;

어노테이션을 선언할 때

  • 롬복(lombok)은 최상위에 작성
  • 필수적으로 필요한 거를 클래스 바로 위에 작성
    • @Controller, @Service, @Repository, @Entity는 클래스 바로 위에 작성
  • 변경 가능성이 높은 것일 수록 위에 작성하기
@Getter
@RequiredArgsConstructor
@RequestMapping
@RestController
public class CommentController {
    ...
}