[클린 코드] 세 살 코딩 스타일 여든 간다

엊그제 친구에게 레전드 썰을 들었습니다

친구의 직장 후배인데, 코딩 스타일이 개떡 같더군요

 

check 함수 안에서 DB작업을 하고, 함수 이름을 func2(), func3() 이런 식으로 짓는다더라고요

이야기를 듣는데 숨이 막혔습니다

 

그래서 오늘 주제는 클린 코드입니다

 

클린 코드의 중요성

1. 가독성 확보

코드는 개발자가 읽기 쉽고 이해하기 쉬워야 합니다

함수와 변수의 이름은 명확하고 간결하게 작성되어야 하며, 주석은 필요한 경우에만 사용되어야 합니다

(참고로 42서울에서의 코딩 컨벤션은 함수당 25줄 제한, 한 줄에 80글자 제한 등이 있었습니다)

 

2. 유지보수성 향상

클린 코드는 변경이 쉽고 유지보수가 간편합니다

새로운 기능 추가나 버그 수정이 빠르게 이루어질 수 있도록 코드는 작성하는 것이 중요합니다

 

3. 버그 감소

클린 코드는 버그 발생 가능성을 줄입니다

명확한 로직과 간결한 코드는 개발자가 실수를 줄일 수 있도록 도와줍니다

 

클린 코드의 원칙

1. 의미 있는 이름 사용

변수, 함수, 클래스 등의 이름은 해당 역할을 명확히 나타내야 합니다

일반적인 약어는 피하고, 이름의 길이보다는 의미를 중시해야 합니다

보통은 변수는 명사, 함수는 동사를 사용합니다

 

2. 작은 함수 사용

함수는 작고 명확해야 합니다

한 함수는 한 가지 일만 담당하도록 작성하여 코드의 가독성을 높입니다

 

3. 주석은 필요한 곳에만 사용

코드 자체가 자명하게 설명되지 않는 부분에 주석을 추가합니다

주석은 최소화 하고 코드 자체가 설명할 수 있도록 노력해야 합니다

(코드 자체가 자명하냐? 는 판단은 개발자 실력에 따라 다를 것 같습니다. 적절한 상황에 좋은 주석을 다는 고민이 필요합니다)

 

4. 불필요한 코드 제거

사용되지 않는 코드는 제거되어야 합니다

불필요한 코드는 혼란을 야기하고 유지보수를 어렵게 만듭니다

(제 친구의 직장 후배가 안 쓰는 함수를 삭제를 안 하고 남겨두었다고 합니다..ㅎ)

 

결론

클린 코드는 단순히 코딩 스타일이나 규약을 따르는 것 이상의 의미를 가지고 있습니다

클린 코드를 통해 개발자 간의 협업이 원활하게 이루어지며, 지속적인 품질 향상이 가능해집니다