Java 코멘트에서의 /** 및 /*

Java 코멘트에서의 /** 및 /*

와의 차이는 무엇입니까?

/**
 * comment
 *
 *
 */

그리고.

/*
 * 
 * comment
 *
 */

자바어?언제 사용하면 좋을까요?

첫 번째 형태는 자바독이라고 불립니다.코드용 정식 API를 작성할 때 이 API를 사용합니다.이 API는 코드에 의해 생성됩니다.javadoc예를 들어 Java 7 API 페이지는 Javadoc을 사용하며 이 툴에 의해 생성됩니다.

Javadoc에서 볼 수 있는 몇 가지 공통 요소는 다음과 같습니다.

• @param이 있을 사용합니다.

• @return: 이은 어떤 때 사용합니다

• @throws: 입력이 를 발생시키는 을 나타내기 사용합니다

• @since: 이한 가장 버전을 나타내기 사용됩니다.자바버전은 이 클래스 또는 함수가 사용 가능했던 버전입니다.

를 들어를를음, 음음음 the .compare의 of의 Integer:

/**
 * Compares two {@code int} values numerically.
 * The value returned is identical to what would be returned by:
 * <pre>
 *    Integer.valueOf(x).compareTo(Integer.valueOf(y))
 * </pre>
 *
 * @param  x the first {@code int} to compare
 * @param  y the second {@code int} to compare
 * @return the value {@code 0} if {@code x == y};
 *         a value less than {@code 0} if {@code x < y}; and
 *         a value greater than {@code 0} if {@code x > y}
 * @since 1.7
 */
public static int compare(int x, int y) {
    return (x < y) ? -1 : ((x == y) ? 0 : 1);
}

두 번째 양식은 블록(복수행) 주석입니다.코멘트에 여러 행을 포함할 경우 이 옵션을 사용합니다.

후자의 형식만 사용하는 것이 좋습니다.즉, 메서드/복잡한 함수의 동작을 기술하지 않는 블록 코멘트로 코드에 부담을 주고 싶지 않습니다.

Javadoc은 두 가지 중 더 잘 설명되며, 이를 사용하면 실제 문서를 생성할 수 있으므로 단순한 블록 주석보다 Javadoc을 사용하는 것이 더 좋습니다.

Java 프로그래밍 언어의 경우 두 언어의 차이는 없습니다.Java에는 2종류의 코멘트가 있습니다.기존 코멘트(/* ... */ 엔드 코멘트 「 」 。// ...) 「Java Language Specification 」를 참조해 주세요.자바 프로그래밍 언어에서는/* ... */ ★★★★★★★★★★★★★★★★★」/** ... */는 기존 코멘트의 인스턴스이며, Java 컴파일러에 의해 둘 다 완전히 동일하게 취급됩니다.즉, 이러한 코멘트는 무시됩니다(또는 보다 정확하게는 공백으로 간주됩니다.

그러나 Java 프로그래머로서 Java 컴파일러만 사용하는 것은 아닙니다.컴파일러, IDE, 빌드 시스템 등 툴 체인 전체를 사용합니다.이러한 툴 중 일부는 Java 컴파일러와 다르게 해석합니다.히,는/** ... */코멘트는 Java 플랫폼에 포함되어 문서를 생성하는 Javadoc 툴에 의해 해석됩니다.Javadoc 툴은 Java 소스 파일을 스캔하고 그 사이에 있는 부분을 해석합니다./** ... */문서로서 사용합니다.

은 ''와 태그와 비슷합니다.FIXME ★★★★★★★★★★★★★★★★★」TODO: 과 코멘트를 // TODO: fix this ★★★★★★★★★★★★★★★★★」// FIXME: do that대부분의 IDE는 이러한 코멘트를 잊지 않도록 강조 표시합니다.그러나 Java에 있어서, 그것들은 단지 코멘트일 뿐이다.

첫 번째는 자바독 코멘트입니다.는 러한리 the 에서 처리할 수 .javadocAPI를 사용합니다.두 번째는 일반적인 차단 댓글입니다.

JLS의 섹션 3.7을 읽으면 Java 코멘트에 대해 알아야 할 모든 것이 잘 설명됩니다.

코멘트에는 2종류가 있습니다.

• /* 텍스트 */

기존 코멘트: ASCII 문자 /*에서 ASCII 문자 */ 에 이르는 모든 텍스트는 무시됩니다(C 및 C++ 와 같음).

• //텍스트

줄 끝 주석: ASCII 문자 //에서 줄 끝까지의 모든 텍스트는 무시됩니다(C++와 같습니다).

---

당신의 질문에 대해서,

첫 번째 거

/**
 *
 */

Javadoc Technology를 선언하기 위해 사용됩니다.

Javadoc은 소스 파일 집합의 선언 및 문서 주석을 구문 분석하고 클래스, 인터페이스, 컨스트럭터, 메서드 및 필드를 설명하는 HTML 페이지 집합을 생성하는 도구입니다.Javadoc doclet을 사용하여 Javadoc 출력을 사용자 정의할 수 있습니다.Doclet은 Doclet API로 작성된 프로그램으로, 툴에 의해 생성되는 출력의 내용과 형식을 지정합니다.HTML, SGML, XML, RTF, MIF 등 임의의 종류의 텍스트파일 출력을 생성하는 문서를 작성할 수 있습니다.Oracle은 HTML 형식의 API 문서를 생성하기 위한 표준 문서를 제공합니다.API 문서 작성과 관련이 없는 특수한 작업을 수행하는 경우에도 Doclet을 사용할 수 있습니다.

것은, 「」를 참조해 주세요.DocletAPI를 참조해 주세요.

두 는 JLS 의 모든 합니다./* ★★★★★★★★★★★★★★★★★」*/따라서 여러 줄의 코멘트를 작성하기 위해 사용됩니다.

---

Java 코멘트에 대해 알고 싶은 기타 사항

• 코멘트는 중첩되지 않습니다.
• /* and */로 that로 //.
• // has has that that that that has that has has that that that that that that that that that that that that that that that that로 시작하는 가 없습니다./* or /**.
• 어휘 문법은 문자 리터럴(§3.10.4) 또는 문자열 리터럴(33.10.5) 내에서 코멘트가 발생하지 않음을 의미합니다.

따라서 다음 텍스트는 하나의 완전한 코멘트입니다.

/* this comment /* // /** ends here: */

기존 답변이 이 부분을 적절하게 다루지 못했다고 생각합니다.

언제 사용하면 좋을까요?

내에서 API마다 .public, "" " " " " " " " " " "protected 및 final반.Javadoc은 전제조건, 사후조건, 유효한 인수, 런타임 예외, 내부 호출 등 메서드 시그니처로 전달할 수 없는 모든 것을 커버해야 합니다.

내부 API(같은 프로그램의 다른 부분에서 사용되는 API)를 작성하는 경우 Javadoc은 거의 중요하지 않습니다.그러나 유지관리 프로그래머의 이익을 위해 올바른 사용법이나 의미를 즉시 알 수 없는 모든 방법 또는 필드에 대해 Javadoc을 작성해야 합니다.

Javadoc의 "킬러 기능"은 Eclipse 및 기타 IDE와 긴밀하게 통합된다는 것입니다.개발자는 식별자 위에 마우스 포인터를 놓으면 식별자에 대해 알아야 하는 모든 것을 알 수 있습니다.경험이 풍부한 Java 개발자에게는 항상 문서를 참조하는 것이 제2의 천성이 되어, 독자적인 코드의 품질이 향상됩니다.API가 Javadoc에서 문서화되지 않은 경우 숙련된 개발자들은 API를 사용하고 싶어하지 않을 것입니다.

다음 Java 코드 목록에 있는 코멘트는 회색으로 표시된 문자입니다.

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Java 언어에서는 다음 3종류의 코멘트가 지원됩니다.

/* text */

합니다./*로로 합니다.*/.

/** documentation */

문서 주석(doc 주석, 줄여서)을 나타냅니다.코멘트를 은, 이 코멘트를 ./* ★★★★★★★★★★★★★★★★★」*/JDK javadoc 도구는 자동 생성된 문서를 준비할 때 문서 주석을 사용합니다.

// text

합니다.//마지막까지.

사용 시기에 대해서는, 다음과 같이 설명합니다.

// text코드 한 줄에 코멘트를 붙이고 싶을 때 사용합니다.

/* text */여러 줄의 코드를 코멘트할 때 사용합니다.

/** documentation */프로그램 문서 자동 생성에 사용할 수 있는 프로그램에 대한 정보를 추가할 때 사용합니다.

첫 번째는 클래스, 인터페이스, 메서드 등에서 정의한 Javadoc용입니다.클래스가 수행하는 작업이나 메서드 등에 대한 코드를 문서화하고 이에 대한 보고서를 생성하는 데 Javadoc을 사용할 수 있습니다.

두 번째는 코드 블록 댓글입니다.예를 들어 컴파일러가 해석하지 않을 코드 블록이 있다고 가정하고 코드 블록 코멘트를 사용합니다.

다른 하나는 // 코드 진행 행이 무엇을 해야 하는지 지정하기 위해 스테이트먼트레벨에서 사용합니다.

//TODO와 같은 다른 것도 있습니다.이것에 의해, 나중에 그 장소에서 뭔가 하고 싶은 것이 표시됩니다.

//FIXME는 임시 솔루션이 있지만 나중에 방문하여 개선하고자 할 때 사용할 수 있습니다.

도움이 되었으면 좋겠다

• 단일 코멘트(예: //댓글)
• 여러 줄 코멘트 예: /* 코멘트 *
• javadoc 댓글 예: /** 댓글 */

Java는 다음 두 가지 유형의 주석을 지원합니다.

• /* multiline comment */: 과 같은 모든 /*로로 합니다.*/ 줄에 걸쳐 수 있습니다 코멘트는 여러 줄에 걸쳐 있을 수 있습니다.

• // single line: 과 같은 모든 //마지막까지.

javadoc 등의 일부 툴에서는 목적에 따라 특수한 여러 줄 설명을 사용합니다.예를들면/** doc comment */는 javadoc에서 자동 생성된 문서를 준비할 때 사용하는 문서 설명이지만 Java의 경우 여러 줄의 간단한 설명입니다.

언급URL : https://stackoverflow.com/questions/29815636/and-in-java-comments