Intellij 에서 주석, 코멘트 다는법 (javadoc comment)

인텔리제이에서 주석 단축키는 기본적으로 이렇게 두개가 있는데

 

가끔보면 이렇게 규칙적으로 작성된 주석도 있다

이는 javadoc 이라고 하는 자바 코드의 API 문서를 자동으로 생성하는 도구의 형식인데 (이하 javadoc 형식),

javadoc 형식을 사용하면 개발자는 자신이 작성한 코드에 대한 문서화를 간편하게 할 수 있으며. 다른 개발자들이 해당 코드를 쉽게 이해하고 사용할 수 있도록 도와준다.

그리고 인텔리제이에서 이러한 javadoc 형식의 코멘트를 작성하기위해서는 키맵을 설정할 필요가있다.

 

File > Settings (단축키 Ctrl + Alt +S)

 

Keymap > Fix doc comment > Add Keyboard Shortcut

 

사용하고자하는 키 조합 입력 후 OK

 

기존에 해당 키조합으로 연결된 기능이 있는데 어떻게하겠냐는 건데

상관없으면 그냥 기존 조합을 제거 Remove 선택해준다

 

키 조합 적용된거 확인하고 OK

 

기존에 작성한 메서드가 있는경우 커서를 올려놓고 설정한 키 조합을 입력해줍니다

 

메서드에 포함된 param, return 등 각 구성요소에 맞춰 javadoc 형식의 코멘트가 자동으로 생성되는걸 볼수있습니다.

여기서 추가로 설정을 하면 좋은게있는데 

 

File > Settings (단축키 Ctrl + Alt +S)

Editor > General > Other

Show quick documentation on mouse move 체크

OK

 

메서드이름에 마우스를 갖다대면 이렇게 javadoc 형식으로 작성한 코멘트가 표시되어 해당 메서드가 어떠한 기능을하고 어떠한 구성요소를 요구 및 반환하는지 간편하게 확인할 수 있다.