Skip to content

코드 컨벤션

Do Won Lee edited this page Dec 16, 2019 · 8 revisions

테코브러리 코드 컨벤션 (추후에 깔끔하게 분리)

  • 메서드의 인자만 final 키워드를 붙인다.

  • 클래스의 첫 필드는 한 줄 띄운다.

  • Service layer에서 Controller로 DTO를 반환한다. (지금은)

  • ResponseEntity의 body는 Model을 주입한다.

  • 생성자의 인자가 4개이상일 경우 빌더패턴을 적용한다.

  • 클래스의 생성자에 Autowired 어노테이션을 붙인다. (인텔리J 구버전을 위해)

  • 커스텀한 예외 클래스의 메시지는 public static으로 예외 클래스 안에 선언한다.

  • public 메서드에서 사용하는 private 메서드는 public 메서드의 바로 아래에 위치한다.

  • 코드가 길어져서 코드가 오른쪽 기준선을 넘을때만 줄바꿈을 한다.

  • 유효성 체크하는 로직은 메서드로 분리한다.

  • 컨트롤러 테스트에서 body의 값은 is() 메서드를 이용해서 테스트한다. (shortcut)

  • Merge 할 때 메시지는 [MERGE #${commit number}] from ${작업자}/${branch name}

Clone this wiki locally