자바스크립트로 주석남기기와 변수이름

in #kr6 years ago

tic-tac-toe 게임 만들기 자바스크립트 부분 시작 !

html과 css에 대한 부분은 자바스크립트 부분이 끝나면 코드만 연결시키도록 하겠습니다. 자바스크립트 부분이 워낙 방대하기 때문에 원래 컨텐츠에 방해가 될 수 있다고 생각해서입니다.

"나의 코드"가 "남의 코드"로 변하는 시간은 길지 않다.


사람은 망각의 동물입니다. 시간이 지나면 자연스레 다 까먹게 되죠. 코드도 똑같습니다.

mistake-1966448_640.jpg

작성할 때엔 다 알고 있는듯이 넘어가지만.. 시간이 흐르면 "내가 왜 이렇게 작성했지..? 이부분은 뭐지?" 이렇게 질문하는 자신을 발견하게 되죠. 코드가 짧다고 좋은 것이 아니라 다른 사람(미래의 나를 포함해서)이 이해하는 시간이 짧아야 좋은 코드입니다.

이해하는 시간을 줄이기 위한 좋은 습관


무언가를 쉽게 이해하려면 쉽고 적절한 설명이 있으면 됩니다. 프로그래밍에서 설명을 해주는 부분은 무엇이 있을까요 ? 바로 주석과 변수이름입니다.
주석은 컴퓨터는 읽지 않고 사람들이 이해하는데 도움을 주는 것을 말합니다.

//자바스크립트에선 이렇게 슬래쉬2개 뒤에 쓰는 문장은 주석처리가 됩니다.

//여러줄 일땐
//이렇게 주석처리해주시면 됩니다.

즉 적절히 주석을 사용해서 설명을 해주면 다음에 코드를 봤을 때 크게 도움이 됩니다.

변수이름은 왜 설명에 도움이 될까요?


변수에 대해서 간략히 설명하면 값을 저장하는 상자입니다. 주석은 설명을 위해 만들어져 있기 때문에 쉽게 이해할 수 있지만 값을 저장하는 변수이름까지 설명에 중요하다는 건 직관적으로 이해하기 힘들수도 있습니다. 제가 steemit id를 저장한다고 가정했을 때 s라는 이름을 지어준다면 나중에 봤을 때 또는 남이 봤을 때 이 s가 무엇을 뜻하는 지 이해하는데 오랜 시간이 걸릴수도 있습니다. steemit_id라고 하면 바로 이해할 수 있는데 말이죠.

코드가 짧은게 좋은게 아니라 이해하는 시간이 짧은 코드가 좋은 코드입니다.
적절한 이름과 적절한 설명을 적는 것은 쉬운 듯 아주 어려운 행동입니다. **게임을 같이 만들면서 저보다 더 적절한 변수 이름을 알게된다면 이름을 자유롭게 바꾸시면 되고, 자기가 생각하기에 설명이 필요한 부분이라면 주석도 꼭 남겨주세요!**


다음 포스팅에서부터 변수를 선언하는 방법과 게임에 필요한 변수를 선언해보겠습니다.

Sort:  

명언이네요..."코드가 짧은게 좋은게 아니라 이해하는 시간이 짧은 코드가 좋은것이다"
항상 기억 할께요^^

ㅎㅎㅎ 저도 항상 마음에 새기고 노력하고 있습니다(손과 머리는 잘 안따라주네요 ㅎㅎ)

주석 참 좋아요 주석이 있기에 쉽게 잘 찾아가서 할수 있는것같아요 ㅋㅋ

맞아요 ~ 하지만 좋은 주석 남기기는 어렵다는게 함정입니다 ㅎㅎ

(jjangjjangman 태그 사용시 댓글을 남깁니다.)
호출에 감사드립니다! 즐거운 스티밋하세요!

들려주셔서 감사합니다 ㅎㅎ

리스팀을 해주시다니 ㅎㅎ 감사합니다 !

저도 요즘 재밌게 코딩 공부 중인데..ㅎㅎ 포스팅 기대할게요~

감사합니다 ! ㅎㅎㅎ

Coin Marketplace

STEEM 0.28
TRX 0.11
JST 0.031
BTC 68745.77
ETH 3744.06
USDT 1.00
SBD 3.76