2.7.3 메서드 주석

각 메서드 주석은 메서드 바로 앞에 붙인다. 메서드 주석에는 다음 기능을 문서화한다.

• 각 매개변수: @param variable description

• void가 아닌 반환 값: @return description

• 메서드에서 던지는 예외(5장 예외, 단정, 로깅 참고): @throws ExceptionClass description

다음은 메서드 주석의 예다.

/**

 * 직원의 급여를 인상한다.

 * @param byPercent 급여 인상 백분율(예를 들어 10은 10%를 의미)

 * @return 인상액

 */

public double raiseSalary(double byPercent) {

    double raise = salary * byPercent / 100;

    salary += raise;

    return raise;

}