CS - 클린코드 작성법

클린코드?

 

• 내가 아닌 다른 개발자가 나에게 물어볼 필요없이 이해하고 작업할 수 있는 코드
• 이해하기 쉽고 변경하기 쉬운 코드
• 모든 팀원이 이해하기 쉽도록 작성된 코드
• 가독성이 중요한 포인트

 

왜 클린코드를 작성해야하나요? 왜 가독성이 그렇게 중요할까요?

 

일반적으로 기존 코드를 변경하고자 할 때, 해석하는 시간과 수정하는 비율이 10:1이라고 합니다. 예로, 코드를 변경하는데 11시간을 사용했다면 코드를 해석하는데 10시간, 수정하는데 1시간 정도 걸린다는 뜻입니다.

 

그렇기 때문에 개발시간을 줄이기 위해서는 코드를 해석하는 시간을 줄여야하고, 당연하게도 코드 가독성이 높을수록 코드를 해석하는 시간이 줄어듭니다.

 

또한, 대부분의 결함은 기존 코드를 수정하는 동안에 발생하므로 이해하기 쉬운 코드를 작성해야 오류의 위험성을 최소화할 수 있습니다.

 

출처 : https://www.samsungsds.com/kr/insights/cleancode-0823.html

 

 

클린코드 작성팁

 

검색 가능한 값으로 만들기

• 상수는 검색되지 않으므로 변수로 감싸기

함수명은 동사로 만들기

• userData(x) -> loadUserData (0)
• 함수명을 동사로 만들면 해당 함수가 하는 일을 개발자가 정확히 알 수 있다
• 기본적으로 함수 1개 == 1개 작업
• 함수명을 동사로 만들면 해당 함수 내부에 2가지 로직이 들어가 있기가 어렵다
• 중요한점은 함수는 1개의 기능만 할 것

함수 인자 개수

• 3개 이하가 적당
• 3개 초과할 경우 객체를 인자로 보낼 것

불리언 값은 인자로 넘기지 않는다

• 불리언 값을 보내면 함수 안에서 if, else 사용하게됨
• 이는 1함수 = 1기능 원칙을 깨뜨림

짧은 변수명이나 축약어는 피할것

• u,i, a 처럼 나만 알아보는 변수명 사용하지 말것
• 타인이 읽어도 이해가능한 변수명 사용

 

출처 

https://kyounghwan01.github.io/blog/etc/how-to-write-clean-code/