[ETC] 가독성이 좋은 코드란 무엇일까?

가독성이 좋은 코드가 좋은 코드라는 말은 많이들 들어봤을 것 같다. 

그렇다면 가독성이 좋은 코드란 무엇일까?

개발자마다 그 의미가 조금씩은 다르겠지만 나는 '다른 사람이 이해하고 유지보수하기 쉬운 코드' 가 가독성이 좋은 코드라고 생각한다. 

 

오늘 포스팅에서는 내가 생각하는 가독성이 좋은 코드의 특징들에 대해 다뤄보려고 한다.

---

가독성이 좋은 코드의 특징

1. 명확한 변수와 함수 이름

• 의미 있는 이름: 변수나 함수 이름이 그 목적과 역할을 명확하게 나타내야 한다.
• 일관된 명명 규칙: 코딩 표준에 맞게 일관성 있게 이름을 지어야 한다. 예를 들어, Python에서는 스네이크 케이스(snake_case)를 사용하고, Java에서는 카멜 케이스(camelCase)를 사용한다.

2. 적절한 코드 구조와 들여쓰기

• 일관된 들여쓰기: 들여쓰기를 통해 코드의 논리적 구조를 명확히 하고, 블록을 쉽게 구분할 수 있게 해야 한다.
• 짧고 간결한 함수: 하나의 함수가 너무 많은 일을 하지 않도록, 작은 단위로 나누어 작성한다.

3. 주석 사용

• 필요한 곳에만 주석: 코드의 의도를 설명하거나, 복잡한 로직을 이해하는 데 도움이 되는 주석을 작성한다. 그러나 코드 자체가 충분히 명확하다면 주석을 과도하게 사용하지 않는다.
• 주석의 일관성: 주석을 일관되게 작성하여, 코드의 특정 부분이나 기능을 쉽게 설명할 수 있도록 한다.

4. 일관된 코딩 스타일

• 코딩 컨벤션 준수: 프로젝트나 팀에서 정해진 코딩 규칙을 따른다. 이를 통해 코드의 일관성을 유지하고, 가독성을 높일 수 있다.
• 정렬과 공백의 적절한 사용: 코드 사이에 적절한 공백을 사용하여 코드가 지나치게 빽빽해 보이지 않도록 한다.

5. 모듈화와 재사용성

• DRY 원칙(Don't Repeat Yourself): 반복되는 코드를 함수나 클래스로 모듈화하여, 재사용 가능하게 만든다.
• 코드의 분리: 큰 파일 하나에 모든 코드를 작성하지 않고, 기능별로 파일이나 모듈을 나눠 관리한다.

6. 에러 처리

• 명확한 에러 처리: 예상 가능한 에러 상황을 코드 내에서 명확하게 처리하여, 코드의 안정성을 높인다.

7. 테스트 코드 작성

• 단위 테스트: 작성한 코드가 제대로 동작하는지 확인할 수 있도록, 단위 테스트를 작성한다.
• 테스트 코드의 가독성: 테스트 코드 역시 가독성이 좋도록 명확한 이름과 구조를 가지도록 작성한다.

---

이러한 요소들이 잘 조화된 코드는 읽기 쉬울 뿐만 아니라, 유지보수하기도 쉽고 확장도 용이하다.

결과적으로, 가독성이 좋은 코드는 개발자들의 생산성을 높이고, 협업을 원활하게 해준다.

 

항상 가독성이 좋은 코드의 특징들을 생각하며 코딩을 하는 습관을 가져보자!