이 글을 노마드코더를 공부하면서 참고로 작성합니다.
클린코드는 언어의 제한없이 코딩의 퀄리티를 올릴 수 있는 방법입니다.
클린코드란
코드 자체로 어떤 프로그래밍인지 설명이 되는 코드를 말한다.
예로 팀으로 일할 경우 내가 작성한 코드를 타인이 살펴볼떄 추가설명없이 이해되는 코드나 혼자서 일할 경우는 과거의 작성한 코드를 코드만으로 이해가 되는 코드를 이상적인 코딩, 클린코드라고 한다.
클린코드의 작업순서
클린코드 작업은 코드작성을 마무리한 상태에서 작업하는 것이 좋다.
우리는 새로운 것을 개발하는 단게에서 클린코드까지 하고자한다면 혼란이 올 수 가 있다.
코드가 어느 정도 윤곽이 잡히는 마무리에 하단의 방법을 참고하여 클린코드롤 변환하는 것이 중요하다.
⭐하루 코드의 마지막단계에서 클린코드로 변환하기⭐
클린코드를 위한 방법
1. 검색가능한 이름을 사용하기 (변수, 함수)
고정적으로 사용하는 값을 상수의 변수로 만들어 사용하자.
2. 함수명은 반드시 동사로 작성하기
해당 함수가 실행하는 작업을 동사형태로 함수에 작성한다.
예를 들어 user에 data를 가져오는 함수라면, userDate()보다 loadUserData()로 이름을 작성한다.
+ 함수는 단 하나의 액션만 수행해야할 수 있도록 한다.
3. 함수의 인수는 3개이하로 전달하기
인수는 최대 3개로 함수에 작성하는 것이 좋다. 인수가 많을 경우 코드에 복잡하기 때문이다.
만일 함수의 전달해야할 인수가 많은 경우에는 객체형태로 변환하여 하나의 객체를 전달하는 식으로 변경한다.
인수에 대한 설명은 하단 글 참고 부탁드립니다.
Function란, 함수의 기능과 Agument(전달인자), Parameter(매개변수) 정의 / [자바스크립트 도장깨기] 인
목차 함수(Function) 프로그램 안에 프로그램(서브 프로그램)으로 각각의 기능을 수행하며 여러 번 재사용이 가능한다. 하나의 함수는 한가지의 기능만을 해야 한다. 함수 이름은 동사 형태로 정의
theseaah.tistory.com
4. boolean값을 인수로 함수에 보내지 말기
bool타입은 true, false를 의미하는 데이터이다.
bool타입을 함수에 전달한다는 것은 함수안에 if / else가 존재한다는 의미이다.
if / else는 새로운 함수를 만들어 따로 분리하는 것이 좋다.
5. 짧거나 축약어의 변수명을 사용하지 말기
i나 a의 의미없는 변수명이나, email를 e로 줄여 변수명을 사용하면 다른 팀원들이 알 수 없다.
그래서 모든 사람들이 알 수 있는 변수명을 사용하자.
댓글