자바 주석

 

 ㅁ 자바 파란색 주석

- /** 

 

혹은 메소드 내에 커서를 위치시켜두고   alt shift j

 

- 일반적인 주석과는 다르다.
메소드에 대한 설명, 매개변수에 대한 설명, 리턴에 대한 설명, 메소드를 누가 개발했는지, 언제 개발했는지, 버전은 뭔지 등을 작성하는 주석
이런 주석을 달아놓는 습관을 들이는 것이 좋다.

 

 

- 이렇게 주석을 달아놓으면 자동완성으로 호출 가능한 메소드가 뜰 때,

오른쪽 메모에 메소드에 대한 주석이 설명으로 표시된다.

 

 

 

 

/**

전달받은 값으로 User 객체를 생성해서 반환해주는 메소드

 

@author                   본인이름

@param id               생성하고자 하는 User 객체의 아이디값

@param pwd           생성하고자 하는 User 객체의 비밀번호값

@param name         생성하고자 하는 User 객체의 이름값

@return                    새로이 생성된 User 객체의 주소값

*/

public User makeUser(String id, String pwd, String name) {

    return new User(id, pwd, name);

}