[Android/안드로이드] Android Studio에서 Javadoc을 사용하는 방법

---

함수에 마우스를 올려보면 함수의 사용 방법이나 관련된 정보가 팝업된다.

사용하려는 함수가 어떤 함수인지 알아낼 때, 전달해야 하는 파라미터값이 무엇인지 보고 싶을 때, 어떻게 사용해야 하는지 알고 싶을 때 함수에 마우스를 대보면 함수의 사용 방법과 파라미터값 등 여러 설명이 되어 있는 팝업 창이 나오는데 이걸 'JavaDoc'이라고 한다. 물론 Java언어여서 'Java'이다.

 

 

 

 

 

---

 

 

 

 

자동으로 완성된 모습

JavaDoc의 사용 방법은 매우 간단하다. 설명을 달고 싶은 함수의 상단부에 '/**'라고 입력한 뒤 엔터키를 입력하면 자동으로 완성해준다. 파라미터값이 있다면 각 파라미터들의 설명도 모두 자동 완성으로 만들어진다. 반환 되어 지는 값도 있다면 이도 마찬가지이다.

 

 

 

 

---

 

 

 

 

 

넣어두었던 정보대로 보여진다.

이런 식으로 작성해두면 다른 곳에서 함수를 사용할 때 마우스를 올려보면 설명을 볼 수 있다. 개인적으로는 주석이 너무 길거나 복잡한 함수들은 여러번 보면서 작업하게 되는 경우가 있는데, 이런식으로 사용하려는 곳에서도 간단하게 설명을 볼 수 있으면 편리하기 때문에 애용하는 편이다. 혹은 개인적으로 사용하려고 자주 사용하게 되는 기능들을 라이브러리화해서 가지고 있는 코드들이 있는데 그런 곳에 사용하면 아주 편리하다. (그리고 굉장히 있어보이는 건 덤)

 

 

 

 

---

이 밖에도 JavaDoc에 넣을 수 있는 정보들은 굉장히 많이 존재하는데, oracle 사이트에서 확인해볼 수 있었다. (링크)

어지간히 복잡하거나 활용도 높은 함수가 아닌 이상 자동완성 되어지는 이 외에는 잘 사용할 일은 없지만 참고하면 좋을 것 같다.