VS Code Extension - Comment Tooltip Linker

취미 창작&제작

우와와앙

08.03

코딩하는 사람만 알아듣는 글이 될 것 같음.

이번에 만들어 본 건, 다른거 만들다가 필요성을 느껴서 만들어 본 거임.

이것 저것 만들다 보면 미래의 나를 위해서 주석을 친절하게 써야 겠다는 걸 절감하게 됨.

일주일 뒤에 보면 이게 당췌 뭐하자고 만든건지 모르겠고. 일주일 뒤의 내가 내 생각대로 고치면 에러가 나지.

기존 코드를 읽고 뜯어고치기가 새로 만드는 거보다 백배 힘듬.

그래서 주석을 최대한 친절하게 작성하려고 여기저기 주석을 도배하다 보면, 다른 부작용이 생김.

주석을 128342803710947120개 파일에 걸쳐 친절하게 작성해 놨는데, 관련 기능을 수정하면, 그 주석을 전부 찾아서 고쳐 써야 할 때가 있는 거임.

그게 가능하겠음? 그렇게 하다가는 결국 주석의 설명과 실제 기능이 불일치하는 지옥에 빠지게 되지.

이건 그러한 딜레마를 해결하기 위해 개발해 본 기능임.

기능을 작성하는 곳에 주석을 달때

// @cmt-anchor 개쩌는기능 이것은 개쩌는 기능입니다

// 레알

// 트루

이런식으로 달아놓고

저 설명이 필요한 곳에

// @cmt-link 개쩌는기능

이라고 해 놓고, 마우스를 @cmt-link 개쩌는기능에 올리면 툴팁으로

이것은 개쩌는 기능입니다

레알

트루

이렇게 출력되게 해놨음.

이렇게 굴러가게 해 놓으면, 기능을 작성할때 기능에다가만 주석을 작성해서 @cmt-anchor 로 태그해놓고,

기능을 수정하면 기능에 붙어있는 주석만 수정하면 다른 모든 곳에서 수정된 내용으로 볼 수 있음.

물론 함수명에 커서 올리면 툴팁뜨는 기능이 기본 JSDOC에 있지만,

.addHook()같은 형태로 기존 모듈에 후킹하면 기존 모듈의 document가 나오고.

또 함수를 쓰기 위해서 함수 자체 기능의 이해 뿐 아니라 전체적인 작동방식에 관한 설명이 필요할 때도 있고 하니까.

개발하는 사람들은 꽤 유용하게 쓸 수 있을거라고 생각함.

vs code extension 탭에 가서 comment tooltip linker 로 검색하면 나옴. 다운받아 쓸 수 있게 해놨음

이번 개발은 그냥 grok이랑 claude 한테 말로 시켜서 했음. 다른거 만드는 중에 이런 주석 기능이 있으면 좋겠다 싶어서 재빨리 만드느라.

code extension에 업로드하는 절차 알아보고 절차 밟는게 더 힘들었음 ㅋㅋ

구쭈 전체 인기글 전체글