Java의 주석

대부분의 다른 프로그래밍 언어와 마찬가지로 Java의 주석은 프로그램 실행 중에 무시되는 문자입니다. 따라서 크기가 커질 염려 없이 프로그램에 필요한 만큼 많은 설명을 추가할 수 있습니다. 주석은 특정 코드 블록, 메서드 또는 클래스의 복잡성을 설명하는 데 사용됩니다. 나중에 이 코드로 작업할 프로그래머에게 메시지를 남기려는 경우에도 사용할 수 있습니다. 아니면 나만의 메모용으로 사용하세요.

댓글을 강조표시하는 방법

Java에는 텍스트에서 주석을 강조 표시하는 두 가지 방법이 있습니다.

구현 설명(코드 설명)

1. 한 줄에 주석 달기

   가장 일반적으로 사용되는 댓글 유형입니다. 이러한 주석을 작성하려면 두 개의 슬래시를 사용해야 합니다 //. 이 경우 주석은 문자 바로 뒤에서 시작하여 //줄 끝까지 계속됩니다.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. 텍스트 블록에 주석 달기

   더 긴 설명이 필요한 경우 각 줄을 기호로 시작할 수 있습니다. 주석 블록을 구분 기호 /*및 */.

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

   기호로 구분된 주석은 Java 언어에 중첩될 /*수 없다는 점을 잊어서는 안 됩니다 . */이는 비활성화되는 코드 자체에 및 구분 기호가 포함될 수 있으므로 코드 조각을 /*및 로 둘러싸는 것만으로는 비활성화할 수 없음을 의미합니다 .*//**/

코멘트 문서화 중

메소드, 변수 또는 클래스를 문서화하기 위해 텍스트를 강조 표시하는 특별한 방법이 사용됩니다. 이는 /**및 를 사용하여 수행됩니다 */. 이 경우 주석 처리된 텍스트의 각 줄은 로 시작합니다 *. 메서드가 문서화되어 있으면 해당 인수와 반환 값을 설명하는 것이 관례입니다.

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

또 무엇을 읽어야 할까요? 예를 들어 다음 자료는 Comments in Java: not everything is so simple 입니다 . 또는 주석에 대한 Java Syntax Pro 퀘스트의 강의입니다 .