⎷ 좋은 코드란 무엇인가?
읽었을 때 이해하기 쉽다. (가독성)
- 변수명, 함수명, 클래스명 등이 명확하고 직관적이어야 한다.
- 코드의 구조가 잘 정리되어 있어야 한다.
- 주석을 적절히 사용해서 코드의 의도를 설명한다. (과도한 주석 X)
유지보수가 쉽다.
- 코드의 변경 및 확장이 용이해야 한다.
- 기능별로 나눠진(모듈화 된) 코드 구조는 수정이 용이하다.
- 코드의 의존성을 최소화하고, 재사용 가능한 모듈(중복 코드 제거 효과)을 작성해야 한다.
코드 의존성이란?
ex) A가 B를 이용하고 있다면, A는 B에게 의존하고 있는 것이다. A는 B없이 작동할 수 없다. B가 변하면 A도 영향을 받는다.
성능 측면에서 효율적이다.
- 메모리 사용, 실행 시간 등을 고려하여 최적화된 알고리즘을 사용하는 것이 필요하다.
성능 최적화는 위의 가독성과 유지보수성을 해치지 않는 선에서 이뤄져야 한다.
테스트하기 쉬워야 한다.
- 유닛 테스트, 통합 테스트 등을 통해서 코드의 기능을 테스트 할 수 있어야 하며, 테스트를 자동화할 수 있는 구조를 갖추는 것이 좋다.
- 코드의 신뢰성을 높이는데 도움이 된다.
테스트 종류
- 유닛 테스트 (Unit Test)
- 통합 테스트 (Integration Test)
- 인수 테스트 (Acceptance Test)
코딩 스타일 및 규칙이 일관되게 유지되어야 한다.
- 규칙과 스타일을 정하고 이를 유지해야 팀원 간 협업이 원활하게 유지될 수 있다.
문서화
- 다른 개발자가 코드를 이해하고 사용하는 데 도움이 된다.
- 히스토리 관리에도 도움이 된다.
simple is best