Tip. 클린 코드를 위한 5가지 팁

2021-12-25

출처 : 노마드 코더 클린코드를 위한 5가지 팁https://youtu.be/Jz8Sx1XYb04

클린코드란?

읽기만 해도 무엇인지 이해가 되는 코드

팀원을 위해, 그리고 미래의 나를 위해서

팁 1. 검색이 가능한 이름을 써라.

예) 하루가 총 86400초 라면 숫자 그대로 쓰지않고,

const SECONDS_IN_A_DAY = 86400; 

숫자가 무엇을 의미하는지 이해할 수 있도록 하자.

팁 2. 함수명은 동사를 써라.

예) userData() ⇒ loadUserData() 가 좋다.

이렇게 이름을 짓다보면 함수가 너무 많은 역할을 하는 것은 아닌지 알게되기도 한다.

함수는 한가지 기능만!

팁 3. argument(인수)는 3개 이하로 하자. 더 많아진다면 configuration object 를 사용하자.

function makePayment({ price, productId, size, quantity, userId }) { 
 ...
}
makePayment({
  price: 100,
  productId: 5,
  size: 'l',
  quantity: 1, 
  userId: 1000,
}) 

팁 4. boolean값을 인수로 함수에 보내는것을 최대한 지양하자. 이는 곧 함수안에 조건문이 있다는 뜻이다.

각각의 조건에 따라 다른 함수로 분리하는 것이 좋다. 즉, 함수는 단 한개의 기능만 하도록 하자.

팁 5. 짧은 변수명이나 축약어 쓰는 것을 피하자.

예) e ⇒ email, u ⇒ user