[ Java ] #3 주석

네 여러분들 안녕하십니까 홍 드로이드 입니다 ~ !

이번 시간에는 주석에 대해서 공부해봅시다.

주석(Comment)은 프로그래머 (개발자) 가 

1. 프로그램을 만드는 과정에 있어서 생기게되는 의견이나

2. 기억해두어야 할 것 들을 메모 할 때 사용을 하게 됩니다.

3. 소스코드를 잠시 실행 제외 시키고 싶을때도 주석을 활용합니다.

우선 주석문의 예시들을 살펴 보겠습니다.

public class Comment_3 {
    public static void main(String[] args) {
        // 한 줄 주석 (라인 주석)
        /* 블록 주석 */
        // String a = "good"; <-- 소스코드 실행 잠시 막는 경우
    }

    /**
     * test 메소드
        */
    private void test() {

    }

    /**
     * test2 메소드
        * @param a string 타입 문자열 값
        * @param b int 타입 정수 값
        */
    private void test2(String a, int b) {

    }
}

한 줄 주석의 경우 // 으로 표기하는 것은 뒤에 이어지는 한 줄의 내용들은 모두 수행되지 않습니다.

블록 주석의 경우 /*  */ 으로 표기하는 것은 한 줄 뿐만 아니라 /* 로 시작 해서 */ 로 끝나는 모든 줄들을 주석 처리가 가능 합니다. 여러 줄 처리에 도움이 됩니다.

소스코드 주석의 경우 내가 짜놓은 코드에 대해서 지우기는 좀 그렇고 프로그램 수행 시 잠깐 제외 시켜야하는 상황이 생길 때 활용 합니다.

그리고 블록 주석과 비슷한데 초록색 글씨의 주석은 문서 주석 이라고 합니다.

보통 클래스 선언 부 위쪽이나 메소드 위 쪽에 달게 되는 경우가 많은데

구현방법은 Intelli J 나 Android Studio 에서 /** 작성 후 ENTER를 치시면 자동으로 좌르륵 초록 주석이 생겨나게 됩니다.

중괄호 내부에서 사용되기보다 외부에 이 클래스 파일은 크게 어떤 것이다. 

또는 이 메소드가 어떤 역할을 한다. 라는 정도로 작성하기에 좋습니다. (저도 실제로 많이 활용합니다.)

문서 주석 같은 경우 메소드 위에 작성을 하게됬을 때 매개 변수(전달해줄 변수)가 없을 때는 그냥 문서주석만 생겨나고,

String이나 int같은 것을 활용한 매개변수가 있다면 

@param (parameter = 매개변수) 이라는 내용이 자동생성 되어서 이 매개변수는 어떤 의도로 만들었는지 정의도 가능합니다.

여러분들도 긴 코드를 짜게 될 경우 주석을 많이 활용하셔서 메모를 해두는 습관을 초반에 들이시는게 좋습니다.

(물론 Best는 주석이 필요없이 코드가 바로 이해되는 Clean Code를 짜는 것을 더 지향합시다)

추가적으로 궁금하신 점들 있으시다면 댓글 많이 달아주시면 감사합니다.

항상 좋은하루 되세요 !