클린 코드

여기저기서 클린코드에 대한 글을 보다가 정리한 걸 포스팅

 

 

클린코드란?

- 쉬워서 읽었을 때 이해하기 쉬운 코드

--> 누가 봐도 이해가 잘 되는 코드!

 

왜 클린코드?

- 코드를 봤을 때 무슨 일을 하는지 파악하기 쉽다

--> 리뷰가 빨라진다

==> 디버깅이 빨라진다

 

어떻게 해야 클린코드?

--> 규칙을 정하기

 

1. 함수 이름은 동사 / 클래스나 속성 이름은 명사

- 함수는 특정한 동작을 수행하니까 동사

- 클래스나 속성은 동작을 명칭이니까 명사

 

2. 변수는 누가 봐도 확실히 이해할 수 있도록 짓기

- 계좌를 나타내는 변수명: account(O) / acc(X)

--> 변수가 무엇을 뜻하는지 빠르게 파악하기 위함

 

3. camelCase(카멜 표기법)을 사용하기

- testcase보다는 testCase가 test와 Case를 의미하는게 눈에 잘 들어온다

 

4. 함수를 작게 만들기

- 함수 안의 글을 적게 하기

 

6. 함수 인수는 최대한 적게 쓰기

- 인수가 없거나 1개가 좋다

- 입력값이 있는 변환 함수는 반환 값이 있도록

- 인수가 많이 필요하면 독자적인 클래스 생성도 고려하기

 

7. 함수는 한 가지 일만 하기

- 하나가 여러가지 기능을 한다면 여러 메소드로 나누기

--> 1메소드 1기능이면 재사용도 쉬워짐

 

8. 쓸모없는 코드는 지우기

- 안 쓰는 건 삭제해야 다른 사람이 헤깔리지 않음

 

 

사실 처음부터 클린코드가 되기는 쉽지 않다....초보 개발자니까...

그래서 꾸준히 리팩토링해서 좋은 코드로 만들 수 밖에 없다...