본문 바로가기
파이썬

노마드 코더가 제안하는 깨끗한 코드를 위한 5가지 팁

by fecu 2023. 1. 17.
728x90

 

1. 함수에 램던하게 값을 추가할 경우, 변수를 이용해서 값을 추가해라.

 

- 코드를 처음 보는 사람은 이 숫자가 무슨 뜻인지 모를 수가 있다. 대신 이를 변수로 해두면 읽고 이해하기 쉽다.

 

2. 함수명은 반드시 동사를 써라.

 

 - 동사로 쓰면 함수의 역할을 알게 된다. 만약 하나의 함수가 여러가지 동작을 한다면 함수를 쪼개야 한다. 함수는 무조건 단 한가지의 액션만 수행해야 함.

 

3. 함수의 인수는 3개 이하로 줄여라.

 

- 어떤 인수가 어떤 역할을 하는지 알기 어렵다. 많이 필요하다면 configuration object를 이용하라.

 

4. boolean 값을 함수로 보내지 마라.

 

 - 함수 안에 if, else 구문이 있다는 것은 함수가 여러가지 역할을 한다는 것. 차라리 if, else 구문을 이용해 먼저 boolean을 판별하고, 함수를 2개로 나누어 만들어라.

 

5. 짧은 변수명이나 아무도 이해하지 못하는 변수를 쓰지마라.

 

 - 단순하게 e라는 짧은 단어를 쓰면 이것이 무엇을 뜻하는지 아무도 알 수 없다.

 

6. 일단 코드를 짜고 이후에 다듬어라.

 

 - 깔끔하게 코드를 짜려고 신경쓰다보면, 진짜로 해야할 것에 집중하지 못하게 된다. 코드를 짜고 나서 깔끔하게 고치도록 하자.

 

7. 나의 코드는...

 

 - 이때까지 내가 짰던 코드를 보면 동일한 함수의 반복, 함수 내부의 함수, 함수에 그대로 들어가는 range 변수 등 깔끔하지 못한 부분들이 많았던 것 같다. 그리고 오류를 프린트 하지 않고 단순히 except와 pass 구문으로 넘겨버렸더니, 이에 대한 문의가 무척 많았다. 이번에 동국대에서 받는 정보컴퓨터 부전공 연수를 기회삼아 코드들을 재정비하고 깔끔하게 만드는 시간을 가져보려고 한다.

 

 - 그리고 노마드코더님. 유튜브 잘 보고 있습니다^^ 좋은 영상 감사해요!

728x90