개발자라면 한번쯤은 들어봤을 그 단어. 바로 "클린 코드"
클린코드란 무엇이고? 어떻게 해야하는 것인지! 알아보자 🤓
🧹 클린 코드를 한다는게 어떤 의미일까?
개발을 하기 위해 우리 🤓개발자🤓 들은 수 많은 변수명과 함수명을 정해 줘야 한다. (너무 어려워어ㅓ )
개발자들은 개발보다 이름 짓기에 더 어려움을 갖는 사람도 분명 있다. (이츠 미..)
그래서 이번 장에서는 1. 이름 짓는 방법과 2. Clean Code를 하는 방법에 다뤄볼 것이다.
Clean Code : 코드 만으로 이해가 되고, 부연 설명 없이 코드로 설명이 되는 상태
→ 이게 바로 훌룡한 코드의 모습이라 할 수 있다!!
✅ 5가지 Tip !
📱검색이 가능한 이름으로
예를 들어 자동차를 굴리게 하는 함수를 만든다 생각해보자, 그렇다면 함수명을 최대한 간단하게 하기 위해 ‘A‘라는 함수 명으로 지정하면
- 나중에 팀원이 봤을때 해당 함수가 무엇을 하는지 이해하지 못한다.
- 유지보수할때 함수를 찾기에 어려움이 있다.
A처럼 간단하고 의미없는 이름보다, ****❌ ****
✅ 이 함수가 무엇을 하는 동작인지를 설명될 수 있는 간단한 이름을 하는게 좋다.
🚗 함수명은 동사로
함수명을 그들이 하는 역할, 동사로 짓다보면, 구분의 필요성을 느끼게 될것이다.
함수는 어떠한 하나의 동작을 수행하기 위해 함수를 생성하는 것이기 때문에 함수가 동작하는 것이 무엇인가에 따라 함수명을 동사로 지어 함수의 동작성을 과시시켜 팀원이 봤을때 알아보기 쉽게 선정해야 한다.
예를 들어 주행하는 자동차 함수를 만들려고 한다면 함수명을 ‘Car’ 대신 GoCar 또는 ‘MoveCar’라고 정해주는것이 좋다.
🎨 함수는 인수는 3개 혹은 그 이하로
만약 함수가 너무 많은 수의 인수를 필요로하면,
- 다른사람이 봤을때, 혼란스러울 수 있다.
- 인수들 각각의 역할 파악이 어렵다.한개의 confiiguration object를 보내는 것을 추천한다.
- 함수의 역할을 파악하기 좋다.
- 총 몇개의 인수를 필요로하는지 파악하기 좋다.
- 📕 그럼에도 인수가 많이 요구 된다면 ?
👍 Boolean 값을 인수로 함수에 보내는 것을 최소한으로 👎
Boolean 값은 참 혹은 거짓을 의미하는 데이터 타입인데, Boolean 값을 함수에 보낸다는 것은
그 함수 안에 if, else가 있다는 뜻이다.
함수는 단 하나느이 액션만 해야하기 때문에 if-else를 사용해서 조건에 따라 사용하지 않고 함수를 소분화 시켜서 사용하는 것을 추천한다.
😂 짧은 변수명이나 (아무도 이해하지 못하는) 축약어 사용은 자제
예를 들어 C라고 쓰지 말고, Car라고써야한다는 것이다.
팀원이 쓴 코드에서 C라는 변수명을 보면 어떤걸 뜻하는 변수인지 알아보기 힘들기 때문에 짧은 변수명이나 축약어 보다는
✅ 특정을 가리키는 단어를 사용해 무엇을 나타내는 변수인지 명시적으로 알려줘야한다.
자! 이 글을 통해 우리는 이제 클린코드를 왜 해야하는지 어떻게 하는것인지 알게 되었다!
나도 클린코드.. 하려고 노력하지만 잘되지 않는 것이 사실이다.. 개발이 익숙하지 않거나 초보개발자 분들은 개발 완료 후에 마지막으로 점검겸으로 클린코드로 바꿔주는 것도 도움이 될것이다!
처음부터 클린코드하려고 애쓴다면 오히려 코딩이 안될 수 있으니.. !
그런 능력은 점차 키워질 것이다!
'개발 상식' 카테고리의 다른 글
🌐 네트워크 기초 + json (0) | 2022.10.31 |
---|---|
📚 프레임워크와 라이브러리의 차이 (0) | 2022.10.26 |
객체지향 프로그래밍이란? (0) | 2022.10.22 |
🐞 코딩의 시작과 끝 🐞 (0) | 2022.10.13 |
언어의 컴파일 과정 (0) | 2022.10.12 |
댓글