습관성 코드 남발하지 않기 (22.08.24 TIL)

 어제 이번 주중으로 제출했던 과제들 리뷰를 받았는데, 고쳐야 하는 부분들을 정리해 놓으려고 한다. 하나 하나 PR 하고 셀프 체크 할 때는 잘 보지 못했는데 모든 과제물을 한 번에 같이 보니 내 눈에도 너무 의미 없는 코드들이 자주 보였다.

1) 커밋 할 때 의미 있는 메세지 남기기.
  - PR 후 수정하는 코드들을 다시 커밋하고 나서 간단하게 남긴 메세지들 내용이 중구난방 이였다. 어디는 자세하게 써 있는가 하면, 어디에는 'second commit' 이라는 추상적인 말만 써 있어서 이 메세지만 보고 대체 뭘 수정한거지,,하는 생각이 들었다. 커밋 메세지는 최대한 명확하게, 짧은 문장으로 표현이 불가능 하다면 최대한 쉽게 풀어쓰자. 메세지를 보고 맥락 파악이 되지 않는다면 쓰는 의미가 없다.

2) 모든 코드들을 습관적으로 while 문 안에 넣었다.
  - 습관적 while 을 쓰고 모든 코드들을 그 안에 때려박았다. 또 습관적으로 while 안에 조건을 무한 루프 'true' 로 생성하고, 아래에 조건을 닫아 while 을 닫아주었다. 이 행동 때문에 while 문 안에는 굳이 반복하지 않아도 될 코드들도 들어 있었고, 그 코드들을 처리하기 위해 불필요한 뎁스가 또 들어갔다. 의미없는 습관성 while 과 무한루프는 최대한 지양하자.

3) 의미있는 이름으로 변수명을 짓자.
  - 원모양의 별찍기를 하는 과제에서 반지름의 의미가 들어가야 하는 변수에 원=circle 을 집어 넣었다.. 이 변수만 봤을 때는 대체 뭘 출력하는 지 알 수가 없다.
-  랜덤 번호를 나타내는 변수명을 'lineRandomNumber' 이라고 지었는데 너무 추상적이다. 간단하게 'number' 라는 단어로도 충분히 표현 가능하다. 간단하게 나타낼 수 있는데도 너무 자세하게 구구절절 설명할 필요는 없다.

4) 3번과 연결되는 문제점으로, 너무 변수를 남발한다.
  - 조건식을 boolean 변수로 만들어서 집어넣는 형태의 코드 반복이 많이 있었는데, 변수명도 명확하지 않아서 맥락을 파악하기에 어려움이 있었다. 코드도 글을 작성한다는 생각으로 이해하기 쉽게, 가독성 있게 작성하는 버릇을 들이자. 너무 복잡한 로직으로 큰 집중을 요하는 코드는 좋은 코드가 아닐 수도 있다.

---

 action plan : 이제 3주차, 4주차가 되면 더 난이도가 높아질텐데 안 좋은 코드를 쓰는 버릇을 고치지 못하면 대량의 똥코드가 발생하게 될 것이다..최대한 의식적으로 위의 사항들을 지양하는 버릇을 들이고, 내일 이 4가지 사항은 포스트잇으로 써서 모니터에 붙여놓자!