주석

주석

• 프로그램 코드에 대한 적절한 설명을 달아놓는 용도로 사용

• 한 줄 주석 : '//'부터 라인의 끝까지 전부 주석처리

• 범위 주석 : '/'와 '/' 사이의 내용을 전부 주석처리

• 컴파일러는 주석의 내용을 건너뛰기 때문에 성능 저하가 일어나지 않음

• 문자열을 의미하는 큰따옴표 "" 사이에 주석이 있을 경우 주석이 아닌 문자열로 인식한다.

        public static void main(String[] args) {
  
        System.out.println("Fire Punch!!!"); // 파이어 펀치!!!
  
    }

  main 메서드 안에 앞에서 println()문을 입력했다.
  옆에 // 파이어 펀치! 라는 주석을 작성했음에도 주석의 내용이 실행되지 않았다.

        public static void main(String[] args) {
  
        /*
         * 파이어 펀치! 파이어 펀치!! 파이어 펀치!!!
         */
  
        System.out.println("Fire Punch!!!"); // 파이어 펀치!!!
  
    }

  이번엔 println()문 위에 /* */ 를 넣고 그 사이에 문장을 이것저것 집어넣어봤다.
  그럼에도 /* */ 안의 내용은 결과에 영향을 끼치지 않았다.

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

  이번엔 print()문의 ""안에 //, /**/ 문을 넣었는데 그대로 내용이 출력됐다.
  큰 따옴표 "" 안의 내용은 주석으로 인식하지 않고 문자열로 인식하는 것이니 주의해야한다.

주석의 사용 목적 및 사용방향성

1. 남이 내 코드를 쉽게 이해할 수 있게 하기위함.

   • 최선책 : 가독성이 좋은 코드를 짜는 것
   • 그럼에도 코드로만 설명할 수 없는 부분은 있기 마련 -> 어찌됐든 주석은 필요하다.

2. 과도한 주석은 코드 가독성을 해칠 수 있으니 주의