파트 1 - 2) 코드 품질 - 3) 주석

주석 파트 링크 : https://ko.javascript.info/comments

좋지 않은 주석

'이 코드는 ~와 ~을 수행한다' 같은 설명형 주석이 많으면 안된다.
코드 자체만으로 코드가 무슨 일을 하는지 쉽게 이해할 수 있어야 한다. (알고 있지만 그게 쉽지 않다...)

리팩토링 팁 - 함수 분리하기
함수 내 코드 일부를 새로운 함수로 만드는 것이 나을 수 있다.

• 함수 만들기
  코드가 아래로 주욱 늘어지는 경우느 그 코드를 새로운 함수로 만드는 것이 좋다.

**알고리즘이 복잡한 코드를 작성하거나 최적화 하기 위해서 코드를 살짝 비트는 게 아니고서는 간결하고 코드 자체만으로 설명 가능하게 코딩해야 한다.

좋은 주석

1. 아키텍쳐를 설명하는 주석
   고차원 컴포넌트의 개요, 컴포넌트 간 상호작용, 상황에 따른 제어흐름 등은 주석을 다는 게 좋다.

2. 함수 용례와 매개변수 정보를 담은 주석
   JSDoc 이라는 문법을 사용하면 함수 관련 주석을 달기에 유용하다. (현재 사무실에서는 api 호출 관련 주석을 달 때 이 문법을 이용하고 있다.)

ex)
<script>
/*
@param { number } : x 거듭제곱할 숫자
*/
</script>

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

4. 미묘한 동작을 하는 기능과 어디에 쓰이는 기능인지 설명하는 주석
   코드를 보고 든 생각과 다르게 미묘한 방향으로 동작을 하는 코드의 경우는 주석을 다는 것이 좋다.