Clean code를 위한 5가지 팁

---

좋은 코드란?

좋은 코드에 대한 생각은 사람마다 다를 수 있고, 또 좋은 코드를 짜기 위한 조건도 다를 수 있다.

복잡하게 생각하지 않고, 나는 좋은 코드란 코드 그 자체로 설명이 되는 코드라고 생각한다. 읽기만 해도 어떤 기능을 하는 코드인지 이해가 되고 1년 뒤에 내가 짠 코드를 읽었을 때 코드만으로 이해가 될 수 있다면 좋은 코드가 아닐까 생각한다.

---

좋은 코드를 위한 5가지 팁

1. 검색이 가능한 변수명을 지을 것
   
   위의 코드와 같이 86400 이라는 숫자를 그대로 파라미터로 넘기면 다른 개발자가 봤을 때 뭐지 싶을 수 있다. 숫자가 무엇을 의미하는지 사람이 읽고 이해하기 쉬운 변수명으로 작성하자.

2. 함수의 역할은 한 개만, 그리고 함수명은 동사로
   
   모듈화를 통해 프로그래밍을 하면 유지 보수에 유리하다. 유지 보수에 유리하다는 뜻은 구조를 파악하기 쉽고 고치기 상대적으로 편리하다는 뜻이다. 따라서 하나의 함수가 한 가지 역할만 하도록 적당한 사이즈의 로직으로 구성하는 것이 좋다.
   또한 함수명을 동사로 적으면 이 함수의 역할이 뭔지 파악하기 좋다. 위 코드와 같이 userData 가 함수명인 것 보다 loadUserData가 함수명이면 아, 이 함수의 역할은 UserData를 불러오는 거구나 파악이 되고, 다른 작업을 하려면 또 다른 함수로 분리해야 될 때임을 알아차릴 수 있다.

3. 함수 Argument의 적당한 수는 3개 이하
   
   위 코드 같이 함수가 받을 argument가 많아지면 어느 자리에 어떤 변수가 들어가는지 눈으로 한참 따라가면서 봐야 한다.
   최대 3개까지가 한 눈에 파악하기 쉽고 또 어쩔 수 없이 넘겨야 할 파라미터가 많아지게 되면 아래 코드와 같이 그 정보를 묶어서 한개의 객체로 보내도록 하자.
   

4. Boolean 변수를 함수 파라미터로 보내지 말자
   
   위 코드와 같이 true, false의 boolean 변수를 파라미터로 넘기다는 것은 if else 로 로직을 진행시키겠다는 뜻인데, 이 것 보다는 if 와 else 에 해당하는 함수를 두 개를 각각 따로 만들어 코딩하는 것이 좋다.
   이렇게 하면 함수의 역할은 한 개만 이라는 규칙도 지킬 수 있게 된다.

5. 한 글자 변수명 또는 아무 의미없는 변수명을 쓰지 말자
   
   동료 개발자가 위 코드와 같이 코딩을 한 것을 내가 이어 받아야 한다고 생각해보자. 직관적으로 다가오기 참 힘든 변수명이다.
   u 대신 user, e 대신 email 뭐가 그리 힘든가!
   누가 봐도 파악하기 쉬운 변수명을 짓자.

---

영상 출처: 노마드 코더 Nomad Coders, 깨끗한 코드를 위한 5가지 팁