[TIL] 20211104 주석/ Dependency cycle via 오류

1. 주석 

항해 99를 할 당시 주특기 멘토님께서는 함수마다 어떤 역할을 하는지 간단하게 주석으로 적어놓는 것이 좋다고 하면서

우리팀 코드를 예시로 보여주었었다.

예를 들면

// 영화 리스트 모두 불러오기

이런식의 주석이었다. 

그래서 나는 이번에도 개인 프로젝트를 할 때 함수마다 어떤 함수인지 간단하게 적어놓았다. 

그런데 pr을 올리고 피드백 온 것을 보니 주석은 없을수록 좋고 주석이 필요할 정도의 코드라면 리팩토링을 하는것이 좋다는 것이다. 

도대체 누구의 말이 맞는지 !?!? 그리고 난 주석이 있으면 코드 찾기도 더 쉽고 좋다고 생각했는데 실무에서는 그렇게 하지않는다니! 하면서 찾아보았다. 

 

https://danpatpang.github.io/tip/2018/04/12/Tip_java_comment/#%EC%A2%8B%EC%9D%80-%EC%A3%BC%EC%84%9D%EC%9D%84-%EC%9E%91%EC%84%B1%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95

[Tip] 주석을 다는 방법 · Dan pat pang

 

https://curryyou.tistory.com/319

VS CODE: JS 함수 주석 문서화하는 방법(자동완성 툴팁 노출)

 

찾아보니 주석이 없을수록 좋다는 정답이 아닌 것 같다. 

그렇다고 많을수록 좋은것도 아니고 적당한 주석은 필요한 것 같다. 

그래서 주석을 문서화해서 사용하는 방식이 있다.

 

 

2.  Dependency cycle via 오류

2021.11.22 - [에러노트] - [에러노트] Dependency cycle via @/router/index:3

[에러노트] Dependency cycle via @/router/index:3