코드를 깔끔하게 적는 법, CleanCode란 무엇일까(클린 코드)

---

* 해당 포스팅에서 사용되는 언어는 마인크래프트 게임의 Skript 언어입니다.

어렵진 않으니 해당하는 의도는 파악하실 수 있을 것이라 생각됩니다.

 

코드가 깔끔해야 하는 이유는 다음과 같다고 생각한다.

 

자신이 적은 코드를 한 번만 보고 다시 보지 않을 것이 아니기 때문이다.

3, 6개월 혹은 언제든지 다시 볼 때 이해가 되기 쉽도록 적어야 한다.

 

코드를 깔끔하게 하는 방법을 알아보도록 하자.

---

첫째, 지은 이름의 의도를 분명히 밝혀라

예를 들어 매초 시간이 늘어나며 반복되는 스크립트를 적을 때

every second:
    add 1 to {t}

t라는 변수가 뭘 나타내는지 적어줘야 합니다.

t라는 변수가 time, today로 다르게 해석될 수 있기 때문입니다. 

every second:
    add 1 to {time}

위와 같이 변수 이름의 의도가 분명하다면 이후에 시간을 절약할 수 있다.

둘째, 함수는 한 가지만 해라

function LoadUserData()
function SaveUserData()
// 좋은 예시입니다 !

 

함수가 1개 이상의 역할을 하게 되면, 작성, 테스트, 추론하기가 어려워집니다.

함수를 단 하나의 행동으로 떼어낼 수 있다면,

코드는 훨씬 더 깔끔하게 읽힐 것입니다.

셋째, 축약어를 쓰는 것을 피하자

function SendEmail(u) // 좋지 않은 예시입니다.
//
function SendEmail(user) // 좋은 예시입니다.

 

예를 들어 코드를 적을때 축약어를 쓴다면 미래의 당신이 기억하기 어려워 집니다.

코드를 짤 때 당신의 기억력을 믿지 마세요.

 

넷째, 찾기 쉬운 이름을 사용하자

 

우리는 작성해야 할 코드보다 읽어야 할 코드가 더 많습니다.

우리가 작성해야 할 코드를 읽기 쉽고 찾기 쉽게 만드는 것은 중요합니다.

프로그램을 이해하기 쉽도록 변수명을 의미 있게 짓지 않는다면,

코드를 읽는 사람을 곤란하게 만드는 것입니다. 변수명을 찾기 쉽게 만드세요.

---

읽어주셔서 감사합니다.

여러 가지 글들을 읽어보며 작성하였습니다.

 

궁금한 것이나 틀린 맞춤법이 있다면 비밀 댓글로 알려주세요.

---

포스팅이 유용했다면 공감버튼 한 번씩 눌러주시면 감사하겠습니다.

​

앞으로 유용한 포스팅으로 찾아뵙겠습니다. 구독하고 같이 소통하실 분들 환영합니다 ^^

​