[자바] 주석 효율적으로 다는법

https://www.youtube.com/watch?v=ORmnc-hLrYs

js 주석에 대한 내용을 보고 자바도 될 거같아서 한번 정리 해보았다.

 

 

public class Solution {

    /**
     * 문자와 숫자를 더해주는 함수
     * @param str {String}
     * @param num {int}
     * @return {int} - 문자를 숫자로 변환해서 더해줌
     */
    public int sum(String str ,int num){
        return Integer.parseInt(str) + num;
    }
 
}

/** */ 이런식으로 주석과 시작과 끝을 만들어 두고 작성하면 해당 함수에 대해서 호출할 때 마우스 포인터로 가리키기만해도 메서드에 대한 정보를 알 수 있다. 꽤나 유용하게 쓰일 거 같다.