[java 2강] 주석 (주석의 종류,주석의 사용법, javadoc)

[java 2강] 주석(주석의 종류,주석의 사용법)

자바를 시작하면서 꼭알아두어야 할것은 주석이라고 생각합니다.

코드를 작성하는 부분에 메모나 설명을 넣고 싶은대 어떡하지?

그건 바로 주석을 달면됩니다.

주석을 달면 컴파일할때 컴퓨터는 넘어가며 코드로 보지 않습니다.

주석의 종류는 크게 2종류로 분류 됩니다.

한줄짜리 주석, 여러줄 짜리 주석....

한줄짜리 주석은 

// 내용

입력하고 내용을 입력하면 됩니다.

// 이것은 1강에서 설명드린 예제!
public class HelloJava {
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        System.out.println("hello. world");
    }
 
}

위의 예제 같이  "// 이것은 1강에서 설명드린 예제!" <--- 요것이 한줄 짜리 주석입니다.

그럼 여러 줄을 입력하고 싶으면 어떡해야 하나요?

/* 내용 */

이렇게 입력하시면됩니다.

/*
여러줄 짜리 주
우
우
석
*/
/* 그렇다고 한줄이 안되는것은 아님*/
public class HelloJava {
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        System.out.println("hello. world");
    }
 
}

여러줄을 입력할수도있고 한줄도 입력할수 있습니다.

그럼 드는생각이 뭐야 여러줄짜리 주석만 쓰면되잖아? 라고 생각을 하실수 있습니다.

맞습니다. 여러줄짜리 만알아도 상관없습니다.

하지만 직접 써보시면 어떤게 더 편한지 알수 있을겁니다 ㅎㅎ 한줄짜리 주석이 입력이 훨씬 편합니다..(한줄 주석할때)

이렇게 해서 주석적는 법을 알아보았습니다.

마지막으로 실무에서 자주 사용하는 javadoc 까지만 설명드리겠습니다.

javadoc 은 뭘까요?

제가 만약 클래스랑 메소드를 만들었습니다.

당연히 혼자 코딩을 하여 만들었으면 javadoc은 필요도 없습니다.

근대 자바의 장정은 여러사람이 모여 개발을 하기 쉬운 언어 입니다.

그럼 여러사람이 모여서 코딩을 했다고 하면...

다른사람이 만든것을 쓰려고 하는대 설명이 하나도 없내?

뭐 자신이 실력이 좋으면 금방보고 쓸수 있습니다.

하지만... 설명이 있자면 코드를 볼필요도 없고 가져다 쓰기만 하면되겠죠? ㅎㅎ

그래서 javadoc 이라는것이 있는것입니다.

쉽게 말해 내가 작성한 코드를 다른사람이 보고 쉽게 쓸수 있도록 설명을 달아 놓는것이죠.

기본적인 javadoc 에 쓰이는 설명은 이렇게 됩니다.

@author 개발자
@exception 메소드에서의 예외 확인
@param 메소드의 매개변수
@return 메소드의 반환값
@see 다른 주제에 관한 링크 지정
@serial 직렬화 필드
@since 릴리즈 기록
@throws 메소드에서의 예외
@version 클래스의 버전

감이 안오시죠?

예제입니다.

/**
 * 
 * @author 국브
 *
 */
public class HelloJava {
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        System.out.println("hello. world");
    }
 
}

요렇게 

/** */ 주석으로 안에 내용을 넣어주시면 됩니다.

1강에서 사용했던 예제인대요... 개발자 밖에 달게 없어서 개발자만 달았습니다 ㅎㅎ

이렇게 해서 오늘은 주석의 종류, 주석의 사용법, javadoc 에 대해서 알아보았습니다.

그럼 이제 주석을 통해서 설명을 달아놓아도 알아보시겠죠? ㅎㅎ

다음부터는 주석의 설명도 보시면서 블로그의 설명도 보시면서 이해하시면 되겠습니다.

이상으로 2강을 마치도록 하겠습니다.

굼굼한것은 언제든지 댓글로 남겨주시면 답글 바로 달아드리겠습니다.

수고하셨습니다!