처음부터 완벽한 코드는 없다. 작은것부터 바꿔나가자

BackEnd

공통

• 무분별하게 단어 축약하여 쓰지 말고 남이 알아볼 수 있도록 이름 짓기
• 개발자가 실수를 할 수 있는 여지를 주지 말자
  • 변경되지 않아야되는 값은 final을 사용
  • lombok 같은 편의 기능의 getter, setter, ArgsConstrctor 같은 것을 사용하는 좋지만 해당 기능이 지원해주는 범위가 내가 만드려는 객체에 너무 과한 옵션이 아닌지 생각해보자

테스트 코드 작성

• TDD를 기반으로 하기 위해 테스트 코드를 먼저 작성한다.
• DisplayName으로 해당 메서드가 어떤것을 테스트하는지 명시한다
• 메소드명은 한글로 작성한다
• 메소드 네이밍 전략은 다음과 같이 진행한다
  • 메소드명_테스트상태_기대결과 ex) isAdult_AgeLessThan18_False
  • 메소드명_기대결과_테스트상태 ex) isAdult_False_AgeLessThan18

함수에 대한 주석

• backend 에서 공통적으로 사용하는 함수의 경우, 모듈화를 통해 하나의 파일로 관리

• 하나의 파일의 시작 부분에 주석으로 상세 내용을 작성

• 보통 controller 에 작성하며, 함수의 전체 기능에 대한 설명 달기

  • 예시 코드

  /**
   * 이 함수는 메인 페이지에 hello world! 라는 텍스트를
   * 보여줄 수 있게 하는 함수입니다. 
   * 
   * @return
   */
  
  @RequestMapping
  @ResponseBody
  public String helloWorld(){
  		return "hello world! ";
  }
  

Bracket

• 반드시 블록문은 중괄호 로 묶어서 작성하기

   // good case
  if(canHaveIssues()){
  		functionA();
  }
  
  // bad case
  if(canHaveIssues()) functionA();
  

• 들여쓰기는 Tab Size는 4로 설정하여 사용하기