클린코드

최준영·2021년 10월 19일
0

클린코드


  • 클린코드란 읽기 좋은 코드, 가독성 있는 코드를 말한다.
  • 대표적인 예시가 아래에 나와있다.

이름(코딩 컨벤션)

  • 이름 짓는 것은 쉽지 않지만, 가독성에 있어 필수 요소이다.
  • 다음을 고려한다.
    • 함수는 목적에 맞게 이름이 지어져 있는가?
    • 함수 안의 내용은 이름에 어울리게 하나의 로직을 담고 있는가?
    • 함수는 동사 + 명사이며 함수의 의도를 충분히 반영하고 있는가?
    • 함수는 카멜표기법 또는 _를 중간에 사용했는가?
    • 변수는 명사이며 의미 있는 이름을 지었는가?

의도가 드러나는 구현패턴

  • var a = value * 19.2와 같은 코드가 있을 때, 19.2가 무엇을 의미하는지 알 수 없다.
  • 변수로 저장하고, 변수에 적절한 이름을 쓰면 더 좋다.

지역 변수로 넣어도 될 걸 전역 공간에 두지 않기

  • 함수 내에서만 사용이 필요한 것은 지역 변수로 만들어야 한다.
  • 불필요한 전역 변수는 최소화하는 것이 좋다.

if문 중첩 없애기

나쁜 예

function foo(pobi,crong) {
  if(pobi) { 
    if(crong) {
      return true;
    }
  }
}

좋은 예 - return문을 사용하여 중첩을 없앴다.

function foo(pobi,crong) {
  if(!pobi) return;
  if(crong) {
    return true;
  }
}

정적 분석 도구

  • eslint와 같은 도구는 코드를 읽어서 잠재적인 문제와 anit-pattern을 알려준다.
  • 개발도구에서 plugin을 연동해서 활용할 수 있다.
profile
do for me

0개의 댓글