devlog of ShinJe Kim

첫 코드리뷰 회고

|

[부제] 똑같은 실수를 반복하지 말자.

  1. 네이밍
    • 기본, 또 기본을 지켜라.
      • 프로젝트명에는 언더스코어가 안들어간다. -로 연결하자.
      • 코드를 프로젝트에 옮겨심을 때 패키지명을 변경하지 않았다. 꼭 확인하자.
      • 클래스는 항상 대문자로 시작한다. 알고 있었는데 실수했다. 절대 실수하지 말자.
      • 클래스는 명사로 시작하고, 메소드는 동사로 시작한다.
      • 네이밍을 복잡하고 어렵게 하지 말자. 지역변수를 사용할 때에는 풀네임을 쓰기보다는 일반 명사를 사용하자. 만약 전역이면 길어도 명확하게, 지역이면 축약해서(만약 중복이 있다면 구분해줘야 함)(예. passwordResetFragment -> fragment)
  2. 코틀린 문법
    • 코드 중복을 최대한 줄이고 블록을 줄여라.(블록이 중첩될수로 코드가 읽기 어렵다)
      • 뷰단의 id를 불러올때에는 findViewById 할 필요 없이 바로 id를 호출하면 된다.
      • let을 난무하지 마라. let이 중첩되면 코드가 읽기 어려워진다.
      • if 다음에 else가 꼭 필요한 것이 아니라면 쓰지마라. 블록을 최대한 줄여라.
    • 명확한 코드를 작성하라.
      • it 금지. it이 무엇인지 찾아서 대체하라.
      • 사전조건을 먼저 체크하고 return해버리자. 블록 중간에 조건 체크를 하면 블록이 길어지고 중첩된다.
  3. 안드로이드
    • 프로젝트 구조와 패턴을 이해하고 써라.
      • viewModel의 역할이 무엇인지 잘 모르고 썼다. MVVM 패턴 공부해서 정리하자.
    • 기본적으로 제공되는 api를 잘 활용하라. 바퀴를 새로 발명하지 마라.
      • 안드로이드가 기본으로 제공해주는 AlertDialog가 있는데 굳이 fragment를 만들었다. 기존에 있는 것을 활용해야 한다. 커스텀뷰나 복잡한 것이 필요한 dialog는 fragment를 따로 만든다.
    • 안드로이드 라이프 사이클을 완벽히 이해하고 제어해야 한다.
      • onViewCreate에서는 뷰만 불러와라. onViewCreate에서 로직을 넣으면 미처 뷰가 생성되지 않아서 null이 들어올 수 있다. 뷰가 호출 된 뒤에 onViewCreated에서 로직을 작성하라.
  4. 기타
    • 동기/비동기의 실행 흐름을 머릿속으로 그리며 코딩해라.
      • 비동기와 콜백을 제대로 이해하지 못한채로 틀린 코드를 작성하였다. 가장 중요한 부분이므로 반복 또 반복해서 이해하고 숙지하자.
    • 요구사항을 빼먹지 마라.
      • 로딩 애니메이션을 만들라고 했는데 만들지 않는 큰 실수를 범했다. 요구사항을 항상 잘 정리해서 절대 빠지는 것이 없도록 해야한다.
    • 기존의 코드를 그냥 따라하지 마라.
      • 기존에 틀린 코드가 있던 것을 그대로 따라하여 중복된 코드를 작성하였다.(disposeBag부분) 이 부분은 한 번 생각하며 봤으면 의문을 가질 수 있었는데 그렇게 하지 않아서 생긴 잘못이다. 다음번엔 절대 실수하지 말자.

Comments