[Clean Code] 클린 코드

클린 코드

---

1. 클린 코드

---

혼자서 개발할 때는 나만 알아보면 되는, 나만 아는 변수명을 사용해왔습니다. 다른 사람들과 팀 프로젝트를 해보면서 클린 코드의 중요성을 깨닫게 되었습니다. 그래서 클린 코드란 무엇인가에 대해 알아보기 시작했고, 다양한 원칙들이 있다는 것을 알게 되었습니다. 그 중에서 제가 겪었던 기본적인 원칙으로 포스팅 하겠습니다.

 

1. 클린 코드

어플리케이션을 개발할 때 코드의 가독성, 유지보수성, 확장성을 높이기 위해 작성하는 깨끗한 코드입니다.

 

- 주요 원칙

1. 변수명

변수명은 코드의 의미를 명확히 전달해야 합니다.

구체적으로 의미 있는 이름을 사용하여 변수의 역할을 쉽게 이해할 수 있어야합니다.

 

2. 주석

코드 자체가 무엇을 하는지 명확하지 않은 부분에만 작성해야 합니다.

 

저는 팀원들과 협업을 위해 제가 무슨 코드를 작성했는지 일일히 주석을 추가했었습니다.

하지만 주석은 주로 "왜" 이러한 방법을 선택했는지 설명하거나 코드의 의도를 파악하기 어려울 때 사용하는 것이 클린 코드의 원칙임을 알게 되었습니다.

 

3. 함수는 하나의 역할

한 함수가 너무 많은 일을 하게 되면 이해하기 어렵고 유지보수가 어려워집니다.

함수의 길이를 적당하게 유지하고, 각 함수가 어떤 일을 하는지 명확하게 정의합니다.

 

4. 예외 처리

예외 처리할 때는 가능한 한 의미있는 에러 메시지를 제공하고, 오류를 적절히 로깅해야합니다.

 

5. 코드 중복 최소화

동일한 로직이 여러 곳에 반복되면, 수정할 때 모든 곳을 일일이 수정해야 하므로 실수할 가능성도 커집니다.

중복을 피하려면 함수나 클래스의 재사용성을 높이고 중복된 코드를 공통 모듈로 추출하는 것이 좋습니다.

 

6. 간결하게 작성

코드가 너무 복잡하면 이해하기 어려워지고 수정하기도 힘듭니다.

코드의 가독성을 높이기 위해 불필요한 조건문이나 복잡한 로직을 피하는 것이 좋습니다.

---

참고 사이트

클린코드란 무엇인가?

 

[개발서적] 클린 코드(Clean Code) 핵심 요약 및 정리

 

문제가 있으면 댓글 남겨주세요 !

피드백은 언제나 환영입니다 <3