[Java] 주석(comment) 달기

코드를 짜면 짤 수록 코드의 길이는 길어지고, 점점 내가 코드 짠 코드를 이해하고 변경하는게 힘들어진다.

 

내 코드를 유지보수하는 것도 힘들어지는데, 나와 사고방식 등에서 많은 차이가 있는 타인의 코드를 이해하는 것도 보통 일이 아니다. 조직에서 코드를 같이 짜다보면 남의 코드를 봐야할 일을 피할 수 없는데 남의 코드가 이해하기 힘들다면 정말 고통스러울 것이다. 이런 부담을 덜기 위한 기능이 바로 주석기능이다.

 

코드에 영향을 주지 않으면서, 코드 파일에 메모 비슷한 것을 작성할 수 있다.

---

주석 (comment)

• 프로그램 코드에 대한 적절한 설명을 달아놓는 용도로 사용
• 한 줄 주석 : '//'부터 라인의 끝까지 전부 주석처리
• 범위 주석 : '/*'와 '*/' 사이의 내용을 전부 주석처리
• 컴파일러는 주석의 내용을 건너뛰기 때문에 성능 저하가 일어나지 않음
• 문자열을 의미하는 큰따옴표 "" 사이에 주석이 있을 경우 주석이 아닌 문자열로 인식한다.

---

예시1

    public static void main(String[] args) {

        System.out.println("Fire Punch!!!"); // 파이어 펀치!!!

    }

main 메서드 안에 앞에서 println()문을 입력했다.

옆에 // 파이어 펀치! 라는 주석을 작성했음에도 주석의 내용이 실행되지 않았다.

예시2

    public static void main(String[] args) {

        /*
         * 파이어 펀치! 파이어 펀치!! 파이어 펀치!!!
         */

        System.out.println("Fire Punch!!!"); // 파이어 펀치!!!

    }

이번엔 println()문 위에 /* */ 를 넣고 그 사이에 문장을 이것저것 집어넣어봤다.

그럼에도 /* */ 안의 내용은 결과에 영향을 끼치지 않았다.

예시3

    public static void main(String[] args) {

        /*
         * 파이어 펀치! 파이어 펀치!! 파이어 펀치!!!
         */

        System.out.println("Fire Punch!!!"); // 파이어 펀치!!!
        System.out.println("Fire Punch!!! // 파이어 펀치!!!"); // 문자열을 의미하는 큰따옴표 ""안에 주석이 있을 경우 주석이 아닌 문자열로 인식한다.
        System.out.println("Fire Punch!!! /* 파이어 펀치!!! */");

    }

이번엔 print()문의 ""안에 //, /**/ 문을 넣었는데 그대로 내용이 출력됐다.

큰 따옴표 "" 안의 내용은 주석으로 인식하지 않고 문자열로 인식하는 것이니 주의해야한다.

---

주석을 적절히 달자!

주석을 적절히 달면 나중에 코드를 다시 확인했을 때 코드의 유지 보수가 매우 편해지니 자주 사용하는게 좋다.
하지만 너무 많은 주석은 코드 가독성을 해칠 수 있으니 정도껏 쓰도록 할 것!

주석을 적절히 다는 것도 중요한데, 코드를 잘 짜는 것이 가장 중요하니 가장 중요한 깔끔한 코드 작성을 지향하자.