좋은 코드 품질을 가르는 기준

이건회·2023년 2월 8일
0

우테코

목록 보기
2/19

좋은 코드 품질이 무엇인가?

  • 기본적으로 소프트웨어의 주 목적은 문제 해결이다. 즉 내가 원하는 대로 동작하는 코드를 만들어야 한다.
  • 읽기 쉬운 것이 중요하다. 의도를 드러내고 유지보수하기 좋아야 한다.
  • 보기 좋아야 한다. 가독성과는 다르다. 코드가 잘 읽히는 것과 보기 좋은 것은 다르다. 컨벤션을 잘 지키는 등이 중요하다.
  • 관리하기 쉬워야 한다. 소프트웨어는 개발 이후가 가장 중요하다. 잘 작성해도 예상과 달리 동작할 수 있다. 2,3차 사용자들이 관여하는 점에서 중요한 항목이다.
  • 테스트가 가능해야 한다. 테스트가 있어야 잘 동작함을 확인하고, 테스트가 작게 쪼개질수록 잘 짠 프로그램일 확률이 높다.
  • 변경이 쉬워야 한다. 최소한의 노력으로 변경을 하고, 사이드 이펙트를 최소화해야 한다.
  • 효율적이여야 한다. 코드 동작이 아닌 산업적인 관점에서 효율적이어야 한다. 즉 인적 리소스도 포함이다. 최소한의 개발 리소스로 결과물이 나와야 한다.

좋은 코드 품질을 위한 안전장치

  • 하고자 하는 내용을 README에 정리하자. 미션에서 무언가를 얻어갈지, 요구사항이 무엇인지를 적자. 머릿속으로 아는것과 눈으로 보는 것은 다르다.
  • 의사소통을 많이 하자. 코드를 타이핑하는 시간보다 의견을 나누는 시간이 많다. 대화 속에서 설계가 나오면 설계를 바로 코드로 옮겨라
  • 따라서 대화를 통해 구조를 잡고 시작하자
  • 일관성 있게 코드를 작성하자. 기존의 일관성을 유지하자. 여러 명이 짠 것 같은 코드가 나오면 안된다. 새로운 지식을 알았어도 코드를 갈아엎는 것은 좋지 않다.
  • 내가 생각해서 "이 판단이 최적이다" 라는 판단을 계속하자.

생각할 질문

  • 코드 품질이 중요한 이유 중 무엇이 가장 중요한가?

읽기 쉬운 것이 중요한 것 같다. 코드 리뷰를 할 때 네이밍이 제대로 되어있지 않으면 타인의 코드를 이해하기 어려웠다.

  • 위 이유를 만족하기 위한 코드를 작성하기 위해 어떤 노력을 해봤거나 할 예정인가?

네이밍이 중요하다고 생각한다. 네이밍이 조금 길어도 메소드의 역할을 확실히 설명하자. 또 메소드의 길이가 길지 않은 것도 가독성이 쉬워진다.

  • 코드 품질이 높은 코드를 작성하는 프로그래머는 훌륭한 프로그래머인가?

혼자서 일하는 프로그래머는 극히 드물다. 남들과 같이 일하기 편한 프로그래머가 훌륭한 프로그래머라고 생각한다.

profile
하마드

0개의 댓글