코딩 기초 5편 _ Java 주석(Comment) 활용하기

안녕하세요!

지난 시간에 Java 메인 메소드를 알려드렸는데 이해 잘 되셨나요?

오늘은 자바에서 주석(Comment)을 사용하여 코드에 설명을 추가하는 방법을

예시와 함께 알려드리려고 합니다.

그럼 오늘도 힘차게 따라와 보시죠!

 

 

먼저, 한 줄 주석을 사용하는 방법입니다.

// 이 코드는 변수를 초기화하는 예제입니다.
int x = 5; // 변수 x를 5로 초기화합니다.
String message = "Hello, world!"; // 변수 message를 문자열로 초기화합니다.
double y = 3.14; // 변수 y를 3.14로 초기화합니다.

위 코드에서 "//"는 해당 라인에서부터 끝까지 주석 처리를 한다는 의미입니다.

이렇게 주석을 사용하면 코드의 의도나 설명을 간단하게 작성할 수 있습니다.

 

다음으로, 여러 줄 주석을 사용하는 방법입니다.

/*
이 코드는 변수를 선언하고 초기화하는 예제입니다.
변수 x는 int형으로 선언되며, 변수 y는 double형으로 선언됩니다.
*/
int x = 5;
double y = 3.14;

위 코드에서 "/"와 "/" 사이에 작성된 내용은 모두 주석 처리됩니다.

이 방법을 사용하면 여러 줄에 걸쳐 주석을 작성할 수 있습니다.

 

마지막으로, Javadoc 주석을 사용하는 방법입니다.

/**
 * 이 클래스는 덧셈과 뺄셈을 수행하는 계산기를 나타냅니다.
 */
public class Calculator {
       /**
        * 두 정수를 더한 결과를 반환합니다.
        * @param a 첫 번째 정수
        * @param b 두 번째 정수
        * @return a와 b를 더한 결과
        */
       public int add(int a, int b) {
              return a + b;
       }

       /**
        * 두 정수를 뺀 결과를 반환합니다.
        * @param a 첫 번째 정수
        * @param b 두 번째 정수
        * @return a에서 b를 뺀 결과
        */
       public int subtract(int a, int b) {
              return a - b;
       }
}

위 코드에서 "/**"와 "*/" 사이에 작성된 내용은 Javadoc 주석이라고 부릅니다.

이 주석은 클래스, 메서드, 필드 등에 대한 문서화를 할 때 사용됩니다.

"@param"은 메서드의 파라미터를 설명하고,

"@return"은 메서드의 반환값을 설명합니다.

 

 

이상으로 주석을 사용한 자바 코드를 예제와 함께 살펴보았습니다.

어떠셨나요? 이해하기 어렵진 않으셨나요?

매번 새로운 개념들을 접하게 되지만,

뭐든지 반복한다면 본인 것으로 습득하실 수 있을 겁니다.

추가로 궁금한 점이 있다면 언제든지 물어봐주세요!