주석문

실행과 상관없이 설명을 위한 문장으로 //, /_ ... _/, /*_ ... _/(JavaDoc 주석문) 등이 있다.

 

JavaDoc 주석문에서 사용한는 태그들

 

annotation	설명
@version	클래스나 메소드의 버전
@author	작성자
@deprecated	더이상 사용되지 않거나, 삭제될 예정
@since	언제 생성, 추가, 수정되었는가?
@see	외부 링크나 텍스트, 다른 필드나 메소드를 링크할 때 사용
@link see	see와 동일한 기능. 링크 제공
@exception	발생할 수 있는 Exception 정의

기타등등이 있다.

 

활용 예시

 

/**
* 책 한권의 정보를 담기 위한 클래스
*
* @author urstory(<a href="mailto:urstory@gmail.com">김성박</a>)
* @since 2022.03
* @version 0.1
*
*/
public class Book {
    private String title;
    private int price;
	
    public int getPrice() {
		return this.price * 2; // this는 내 자신 인스턴스를 참조하는 예약어.
	}
    public void setPrice(int price) { // 지역변수 price
    	this.price = price;
	}
	
    /**
    * 책의 제목을 반환한다.
    * @return 책의제목
    */
    public String getName() {
    	return title;
    }
    public void setName(String title) {
    	this.title = title;
    }

 

주석문을 잘 작성하는 방법은

주석문이 없어도 이해할 수 있도록 클래스, 메소드, 변수 이름을 작성하고, 꼭 필요한 내용만 최소한으로 작성하는 것이다.