자바 코멘트

자바 코멘트
GfG Practice에서 사용해 보세요.

Java 주석은 코드를 설명하고 가독성을 향상시키는 실행 불가능한 명령문입니다. 이는 컴파일러에서 무시되며 프로그램 실행에 영향을 주지 않습니다.

  • 코드 가독성과 유지 관리성을 향상시킵니다.
  • 논리 디버깅 및 문서화에 유용합니다.

Java는 세 가지 주요 유형의 주석을 지원합니다.

1. 한 줄 주석

한 줄 주석은 한 줄의 코드에 주석을 달 때 사용됩니다.

통사론:   

// 여기에 댓글을 남깁니다.( 이 줄의 텍스트만 댓글로 간주됩니다. )

Java
   // Java program to show single line comments   class   GFG   {      public     static     void     main  (  String     args  []  )      {         // Single line comment here      System  .  out  .  println  (  'Single Line Comment Above'  );         }   }   

산출
Single Line Comment Above  

2. 여러 줄 주석

여러 줄 주석을 작성하는 것은 지루할 수 있으므로 복잡한 코드나 메서드를 설명하는 데 사용됩니다.

/*
댓글 시작
계속
계속...
댓글이 종료됩니다.
*/

Java
   class   GFG   {      public     static     void     main  (  String     args  []  )      {         System  .  out  .  println  (  'Multi Line Comments Below'  );          /* Comment line 1    Comment line 2     Comment line 3    */      }   }   

산출
Multi Line Comments Below  

3. 문서 설명

문서 주석은 Javadoc을 사용하여 외부 문서를 생성하는 데 사용됩니다. 일반적으로 전문 프로젝트에서 클래스 메서드와 매개변수를 설명하는 데 사용됩니다.

통사론:   

/**
* 댓글 시작
* @param 매개변수 이름 설명
* @return 설명
*/

Java
   /**    *     * Calculates the average of three integers.    * @author Pratik Agarwal    * @version 1.0    * @since 2017-02-18    */   public     class   FindAvg  {      /**    * Finds average of three integers.    * @param numA First parameter    * @param numB Second parameter    * @param numC Third parameter    * @return Average of numA numB and numC    */      public     int     findAvg  (  int     numA       int     numB       int     numC  )      {      return     (  numA     +     numB     +     numC  )     /     3  ;      }      /**    * Main method which uses findAvg method    * @param args Unused    */      public     static     void     main  (  String     args  []  ){      FindAvg     obj     =     new     FindAvg  ();      int     avg     =     obj  .  findAvg  (  10       20       30  );      System  .  out  .  println  (  'Average of 10 20 and 30 is: '      +     avg  );      }   }   

산출
Average of 10 20 and 30 is: 20  

관련 기사: JavaDoc 도구


퀴즈 만들기