Today I Learned
날짜
2024년 10월 31일 목요일
내용
누구나 알아볼 수 있는 코드
아임리포트를 떠나보내기 위한 나름의 작업을 착수했다. 그동안 동작하게만 만드느라 함수 이름, 파일 이름등을 개판쳐놨기 떄문이다. 열심히 문서작업도 해놨지만.. 그래도 코드를 보고 어디가 어딘지 쯤은 알 수 있게 해놔야 하지 않을까? 몇가지 규칙을 세워서 정리를 좀 했다.
- 사용하지 않는 것은 무조건 삭제한다.
- 데이터베이스에 접근하는 코드는 crud.py 에 다 모아둔다.
- 함수 이름은 길더라도 뭘 하는지 표현하도록 만든다.
- 함수 내용이 길면 각주로 어디서 어떤 짓을 하는지 써놓는다.
- 예외를 작성한 부분은 그 이유를 각주로 써놓는다.
정리하면서 느낀건.. 정말 코드 더럽게 써놨다. 단 한글자도 빠짐없이 내가 쓴 코드인데도 구조를 파악하기가 힘들었다… process 라는 표현이 드럽게 많고, 추상 클래스를 사용했는데 반복 코드가 한가득이였다. 게다가 중간에 의미 없는 과정이 괜히 들어가 있기도하고… 그때그떄 바로 다음 로직만 보면서 만들다보니 길이 S자로 만들어진 듯 했다.
앞으로도 한번쯤은 전체 코드를 자세히 들여다보면 도움이 될듯 하다.
회고
제대로 작동되는 채로 보내고싶다.
