[JS 스터디] 03. 내 인생 첫 코드리뷰(주석?)

이번주 화요일
내 인생의 첫 코드리뷰 시간을 갖게 되었다.
사실 역량이 부족해서 요구사항을 거의 구현 하지 못하였지만
상상 그 이상으로 알찬 경험이였다.
요구사항을 조금이라도 구현하고 PR를 올려서 참 다행이다 라는 생각이 들었다.

오늘 피드백 받은 내용은 크게 2가지 이다

• 주석은 아무렇게나 쓰는게 아니야
• DOM을 활용했을때의 강점!

• 주석

// 요소를 가져오는 부분
const $menuNameInput = document.getElementById('espresso-menu-name-input')
  ...

// 함수를 정의하는 부분
function addMenu() {
  ...

이런식으로 아무 생각없이 주석을 달았었는데
준님이 코드리뷰를 하는 방법 예시로 저의 코드를 보시면서 지적해주셨다.
코드리뷰를 준님에게 처음으로 받아서 영광이기도 하고 한편으론 창피했다 ㅜㅜ

그래도 이렇게 여러 사람들과 의견을 주고받는
황금같은 시간을 갖게되어 창피한건 금방 사라지고
오히려 좋은 자극이라고 생각하니 기분이 매우 좋았다.

이러한 시간이 앞날에 훨씬 더 많고 더더욱 지적을 해주셨으면 했다.
나는야 변태샏기

결론은 주석은 정말 코드를 볼때 헷갈릴만한 상황에나
보는 사람을 배려해서 쓰는 것이고

사실 정말 알아보기 쉽고
이후에 수정, 유지보수가 쉽게 작성을 했다면
굳이 지저분하게 주석을 추가할 이유가 없다는 것이다.

이렇게 간단한 피드백임에도 불구하고
'클린코드의 중요성'을 실감하였다.

앞으로 함수명, 변수명 그리고 코드의 구조를
클린하게! 작성하는 연습을 자주 해야겠다고 느꼈다.