안녕하세요.
신입 개발자인 저는 깨끗한 코드를 작성하기 위해 노력하고 있습니다.
개인 기록용으로 "노마드 코더 Nomad Coders - 깨끗한 코드를 위한 5가지 팁"을 정리한 포스팅입니다.
"노마드 코더 Nomad Coders - 깨끗한 코드를 위한 5가지 팁" 영상 보러 가기
https://www.youtube.com/watch?v=Jz8Sx1XYb04
깨끗한 코드(Clean Code)란?
돌아가기만 하는 코드가 아닌 코드 그 자체로 설명이 되는 코드
팀 프로젝트라면 내 코드를 팀원들이 읽었을 때 읽기만 해도 무슨 역할의 코드인지 이해가 되는 코드
개인 프로젝트라면 내 코드를 몇 개월, 몇 년 뒤의 내가 읽었을 때 무슨 역할인지 바로 알 수 있는 코드
즉, 부연 설명 없이 코드 그 자체로 코드가 설명이 되는 코드
깨끗한 코드 작성의 주의점
처음부터 깨끗하게 코드를 작성하면서 동작하게 만드는 것은 매우 어려운 일입니다.
일단은 당장 코드가 작동이 되게끔 작성하고 나중에 이쁘게 다듬는 것이 좋습니다.
깨끗한 코드를 위한 5가지 팁
팁 1. 검색이 가능한 변수명을 써라.
코드를 작성하다 보면 고정된 숫자를 사용해야 할 일이 많습니다.
이때 숫자 자체를 이용하지 말고 변수를 이용하는 것이 좋습니다.
예를 들어 하루가 몇 초인지에 대한 코드를 작성할 때 "86400"이라고 코드에 작성하는 것은 좋지 않다는 의미입니다.
다른 사람 혹은 미래의 내가 코드를 봤을 때 86400이 24시간을 초로 환산한 숫자라는 것이 떠오르지 않을 수 있기 때문입니다.
따라서 SECONDS_IN_A_DAY 같은 의미 있는 변수에 86400을 넣어 사용하는 것이 좋습니다.
딱 봐도 하루가 총 몇 초인지에 대한 숫자라는 것을 알 수 있으니까요.
팁 2. 함수명은 반드시 동사로 써라.
함수는 단 하나의 역할만 잘 수행하는 함수가 좋은 함수입니다.
예를 들어 "더하기" 함수와 "더하고출력하기" 함수 중에서 "더하기" 함수처럼
단 하나의 역할만 수행하는 것이 더 좋은 함수라는 뜻입니다.
함수명을 동사로 쓰면 함수가 너무 많은 역할을 하는 것은 아닌지 알 수 있습니다.
함수명은 userData()로 정하면 이 함수가 유저 데이터로 무슨 짓을 하는 건지 전혀 알 수가 없지만
loadUserData()처럼 동사로 함수를 작성하면 이 함수가 유저 데이터를 load 하는 함수라는 것을 바로 알 수 있습니다.
또한 이 함수가 load 이외의 역할을 한다면 함수를 나눠야한다는 것도 쉽게 알 수 있습니다.
팁 3. 함수의 인수는 3개를 넘지 않는 게 좋다.
함수에 너무 많은 수의 인수가 필요하다면 다른 사람이 봤을 때 혼란스러울 수 있습니다.
인수가 많아진다면 한 개의 Configuration Object를 사용하는 것이 좋다고 합니다.
ps. Configuration Object가 정확히 무엇인지는 모르겠지만 각 인수의 명을 함께 넘기는 방법인 것 같습니다.
예를 들어 add(1, 2)가 아닌 add(first: 1, second: 2)처럼 말이죠.
팁 4. boolean값을 인수로 사용하는 것을 자제하라.
boolean값은 참, 거짓을 나타내는 형이고 함수에 boolean값을 넘긴다는 것은
그 함수 안에 if-else가 존재한다는 뜻이고 두 개 이상의 역할을 수행하고 있을 가능성이 높습니다.
함수에 if-else를 쓰지 말고 두 개의 함수로 나눠서 사용하는 것이 좋습니다.
왜냐하면 함수는 "단 한 개"의 역할을 잘 수행하는 것이 좋은 함수이기 때문입니다.
팁 5. 지나치게 짧거나 아무도 이해 못하는 축약어를 쓰지 말자.
변수명을 user 대신 u로 작성하거나 email 대신 e로 작성하는 것은 잘못된 명명 방법입니다.
지나치게 축약하여 변수명을 정한다면 다른 사람이 봤을 때 무슨 의미인지 전혀 알지 못합니다.
당장은 괜찮을지 몰라도 미래의 내가, 혹은 다른 사람이 봤을 때 전혀 알지 못한다면 많이 힘들 것입니다.
제대로 된 단어로 변수명을 정하는 습관을 들이는 것이 좋습니다.