기본 콘텐츠로 건너뛰기

2022 08 26 회사 워크샵

인텔리 J(intellJ) 처음 사용자를 위한 약간의 팁 #15 - Quick Documentation

안녕하세요~

인텔리 j를 써가면서 제가 편하게 쓰는 팁들을 공유하고 싶어서 글을 올립니다... 하여!!

'몰라도 상관없지만 알면 좋은' 팁입니다.

인텔리 j를 시작하시는 분들에게 괜찮은 팁이 되었으면 좋겠습니다.

제가 인텔리 J 라고는 적었지만 인텔리J가 말고 웹스톰 파이참 등.. 젯 브레인에서 제공되는 ide 는 거의 공통으로 사용할 수 있는 팁들입니다~

이번엔 Quick Documentation[Ctrl+q(control+J)] 을 말씀드릴려고 합니다.

코딩을 하다가 보면 해당 메소드가 하는일 또는 해당 메소드에 필요한 파라미터가 무엇인지

디비에서 테이블에 컬럼이 뭐가 있는지 등등 빠르게 알아야 할때가 있습니다.

그때는 Quick Documentation[Ctrl+q(^+J)] 을 이용하면 빠르게 확인이 가능합니다.



예시로 몇개 스크린샷을 찍어봤습니다.   메소드에 대해서 빠르게 알고 싶을때 이걸 이용하면 빠르게 확인 가능합니다.

본인이 작성한 메소드도 doc를 적어두시면 바로 확인 가능합니다.


returnEmpty() 메소드 위에 javadoc 를 적어주시고 호출하는곳에서 [Ctrl+q(^+J)] 눌러보시면
 javadoc의 내용을 보여줍니다.

node.js 에서도 doc를 적고..




호출하는 곳에서 [Ctrl+q(^+J)]를 눌러주시면  doc에 적은 내용이 나옵니다.
메소드명을 잘 작성하여 확인하는 것도 좋지만 doc를 잘 적어두면 나중에 소스 분석을 할때 더 도움이 될수 있습니다.

-database

database 테이블에서도 테이블에 컬럼을 빠르게 확인 가능합니다.
database View를 여시고..


테이블에서 [Ctrl+q(^+J)] 눌러보면 테이블에 정보 및 처음 10건의 데이터가 노출됩니다. 

이번엔 Quick Documentation 에 대해서 말씀드렸습니다.

굳이 메소드가 뭐하는 녀석인지 이 테이블엔 어떠한 컬럼이 있는지 생각하지 마시고 
Quick Documentation 을 이용해보세요~

다음엔 또 다른것을 들고 오겠습니다. 

감사합니다~

댓글