주석

주석

• 주석(comment)은 어떻게 코드가 동작하는지, 왜 코드가 동작하는지를 설명하는 데 쓰임.

좋지 않은 주석

• 코드에서 무슨 일이 일어나는지

• 코드 자체 만으로 무슨 일을 하는 지 알 수 있는 코드 지향.

• “코드가 불분명해서 주석 작성이 불가피하다면 코드를 다시 작성해야 하는 지경에 이른 걸 수 있습니다.”

리팩토링 팁

• 함수 분리하기

함수 내 코드 일부를 새로운 함수로 옮기는 게 유익할 때도 있음

• 함수 만들기

코드가 늘어져 있는 경우 함수를 만들고 분리할 때가 유익할 때 있음

• 코드 분리하고 잘 작성 시 코드 자체 만으로 주석이 필요하지 않을 수 있음

좋은 주석

• 아키텍처를 설명하는 주석

조감도 역할 해줌 UML(고차원 수준의 아키텍처 다이어그램을 그리는 데 쓰이는 언어) 공부 추천

• 함수 용례와 매개변수 정보를 담고 있는 주석

JSDoc이라는 특별한 문법을 사용하면 함수에 관한 문서를 쉽게 작성

• 왜 이런 방법으로 문제를 해결했는지를 설명하는 주석

무슨 일이 일어나고 있는지 파악하려면 무엇이 적혀있지 않은 지가 더 중요할 수 있음

왜 이렇게 문제를 해결했냐 라는 질문에 답변 필요한 경우 있음.

이전에 했던 실수를 방지하는 안내판 역할

요약

• 주석은 코드를 설명해 줌

• 좋지 않은 코드는 일일히 설명하는 코드

• 코드 자체만으로 주석이 필요없어야 함

• 리팩토링 함수 분리하기, 함수 만들기 추천

• 좋은 주석은 아키텍쳐 설명, 함수 용례와 매개변수 정보, 왜 이런 방식으로 문제를 해결했는지.