예시1
코드리뷰에서 충분히 설명했으니 부연설명은 생략함.
예시2
로깅을 하는 함수인데, 구독이라고 적어놨다.
useSubscribeDeviceStatus를 보고 안에서 키네시스 로깅을 한다는 것을 알 수 있나? 없다.디바이스상태를 구독하는 구나, 근데 뭘 하는 걸까? 라는 의문이 생겨서 코드 내부를 봐야만 한다.
또 훅의 이름 자체만으로 행위가 표현되지 않기 때문에, 해당 훅이 무엇을 하는 것인지를 설명하기 위해 상단에 주석이 추가되었다.
과연 주석이 있어야만 할까?
useLogKinesisByDeviceStatus 정도의 이름이면 충분하다.디바이스 상태를 가지고 키네시스에 로그를 남기는 구나 라는 것이 이름만 보고 바로 파악이 된다.
키네시스 로깅의 구체적인 행위가 궁금할 때만 내부를 보면 된다.
별도로 훅 내용을 설명하는 주석도 필요하지 않다.