클린 코드

HKTUOHA·2022년 12월 16일
0

IT 5분 잡학 사전

목록 보기
7/12
post-thumbnail

📌클린 코드란?

  • 설명이 필요 없는 코드

  • 코드를 읽기만 해도 이 코드가 무슨 일을 하는지, 어떤 것을 의미하는지 물어볼 필요도 없이 바로 이해되는 코드

📌클린 코드를 위한 5가지 꿀팁

💡Tip #1

1. 의미 있는 변수, 함수의 이름을 적절히 사용하라.

예)

const SECONDS_IN_A_DAY = 86400;
setInterval(eatKimchi, SECONDS_IN_A_DAY);
  • 변수를 숫자로 바로 넣지 않고, 이름으로 정의하는 게 훨씬 좋다.

💡Tip #2

2. 함수 이름은 가급적 동사로 지어라.

예)

function loadUserData() {
...
}
  • 'userData' 보다는 'loadUserData'로 함수가 무슨 일을 할지 역할을 동사로 짓는 게 좋다.

  • 함수는 1가지 액션만 잘할 수 있도록 한다.


💡Tip #3

3. 매개변수는 너무 많이 쓰지 마라.

  • 함수에서 매개변수는 3개 이하가 적당하다.

  • 만약 매개변수를 많이 설정해야 한다면, "configuration object" 방식으로 매개변수를 묶어 전달하는 방법을 고려할 수 있다.

예)

function makePayment({price, productId, size, quantity, userId}){
...
}

makePayment({
	price: 35,
    productId: 5,
    size: "xl",
    quantity: 2,
    userId: "니꼬",
})

💡Tip #4

4. 불린값을 인자로 보내지 마라.

  • 불린 : 참 혹은 거짓을 위한 자료형

  • 불린값을 매개변수로 사용하면 True와 False, 2가지 일을 처리해야 한다.
    이는 '함수는 1가지 일만 잘해야 한다'는 규칙에 위배된다.


💡Tip #5

5. 축약어를 쓰지 마라.

  • 나 혼자만 알아 볼 수 있는 축약어를 쓰는 건 좋지 않다.

✖️추가 팁

  • 코드가 머릿속에서 막 떠오를 때에는 클린한 코드를 작성하기 힘들다.

  • 일단 잘 실행되는 코드를 막 쓰고, 마지막에 항상 코드를 클린하게 다듬는 작업을 하면 된다.

profile
공부 기록

0개의 댓글