클린코드 & 코드리뷰

Sooyoung·2022년 2월 27일
0

기타

목록 보기
1/1

주제


어떻게 해야 읽기 좋고 이해하기 코드를 만들 수 있는지 알아보고 코드를 리뷰하는 방법을 알아보자


클린 코드


쉽게 말해서 가독성이 좋은 코드가 클린 코드라고 볼 수 있다.

  • 전체적으로 고려해야 할 사항
    + 단일 책임 원칙: 하나의 인터페이스가 하나의 역할을 수행해야한다.
    + 컴포넌트를 분리할 때 시나리오 중점적으로 보는 것이 좋다.
  • 변수명
    + 의도가 분명한 이름

    • 검색하기 쉬운 이름
    • 행위에 대한 개념은 한 단어로 통일
  • 함수
    + 함수명은 동사, 동사구가 좋다. 함수가 하는 일을 서술적으로 표현할 수 있는 이름이 좋다.

    • 인자의 갯수는 0개가 가장 이상적이며 3개이상은 피하는 것이 좋다
    • 하나만 수행하도록 한다. ex) 상태변경, 조회
  • 주석
    + 잘 달린 주석은 정확한 정보를 전달한다. 반대로 제대로 적지 않으면 이해를 방해 적지 않는 것만 못하다

    • 코드의 질이 나빠서 이해를 위한 주석은 좋지 않다.
    • 좋은 주석
      • 법적인 주석, 저작권 정보와 소유권 정보 등등
        • 정보를 제공하는 주석
        • 구현이해를 넘어 결정에 깔린 의도까지 설명
        • 모호한 인수나 반환값이 있을경우 명확하게 밝힘
        • 결과를 경고하는 주석
        • todo 주석
        • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강종하기 위해
    • 나쁜 주석
      • 이유없이 의무감으로 작성하는 주석
        • 코드내용 중복
        • 오해소지 주석
        • 편집 이력
        • 주석 처리한 코드, 해결 됬을 때 바로 지워버리기
        • 너무 많은 정보
        • 코드의 전반적인 정보
  • 형식 맞추기
    + 적절한 행 길이

    • 변수 사용위치 가까이 선언
    • 호출, 개념등 연관되어있는 함수는 가까이 배치
  • 리팩토링
    + 중복 제거


    코드리뷰


    코드 리뷰란, 한 명 또는 여러 명의 개발자가 코드의 내용을 점검(examining)하고, 피드백을 전달하여, 작성자가 이를 다시 반영하는 과정으로 코드에 대한 책임이 그 코드를 만든 사람 혼자에게 있지 않고 우리 모두에게 있다는 문화를 만드는 데에 그 의의가 있다고 할 수 있다.

    ‘책임자를 추궁하지 않는 문화’의 정착

    코드 리뷰를 하는 이유에는 여러가지 이유가 있지만 대표적으로 일관성 유지, 개인 간의 격차 해소, 선제적인 문제점 발견 및 대응, 상호 성장이 큰 이유이다.

0개의 댓글