취미로 이것저것 꼼지락 꼼지락 만드는데

주석달다가 보니 주석의 딜레마 때문에 머리가 너무 복잡해져서

내 생각에 이거 있으면 좋은데 아직 없는것 같은 기능 하나 만들어 봤음

https://marketplace.visualstudio.com/items?itemName=Socrad.comment-tooltip-linker

Comment Tooltip Linker - Visual Studio Marketplace

Extension for Visual Studio Code - Link comments across files using @cmt-anchor and @cmt-link tags with hover tooltips. Simple implementation - feel free to fork and improve!

marketplace.visualstudio.com

https://github.com/Socrad/comment-tooltip-linker.git

GitHub - Socrad/comment-tooltip-linker: VS Code Extension. Link and reference comments across multiple files using tags with hover tooltips.

VS Code Extension. Link and reference comments across multiple files using tags with hover tooltips. - Socrad/comment-tooltip-linker

github.com

// @cmt-anchor 개쩌는기능 이것은 개쩌는 기능임

// 레알 트루

const 개쩌는기능 = asyncWrapper(async 어쩌고저쩌고)

이렇게 작성해 놓고, 여기저기에서

// @cmt-link 개쩌는기능

// 위 기능은 개쩌는기능이라서 저걸 이용해서 이래이래 돌아가고 있음

이런식으로 써 놓으면,

개쩌는 기능을 수정할때 맨 위의 주석만 고치고 다른 곳에서 마우스 커서를 @cmt-link 개쩌는기능에 올리면 수정된 내용으로 참조됨.

이렇게 사용하면 친절하게 여기저기 주석을 써도 기능 수정시의 부작용이 줄어들거라고 생각해서 만들어봤음.

물론 기본 JSDOC도 함수 위에 적으면 설명이 나오긴 하지만,

기존 모듈에 .addHook() 같은걸로 기능을 추가변경하는 경우에 문제가 생길테고

함수에 주석이 묶이면 함수를 통해서만 정보를 제공할 수 있는데, 그러면 전체적인 작동 흐름 같은 함수 외적인 정보 제공에 문제가 있음.

그러니까 원하는 주석을 원하는 위치에 링크시킬 수 있게 만들어두면 유용할 것임.