자바 문서 주석 용법+자바 Doc 사용 설명

간단 한 소개
문서 주석 은 설명 류,인터페이스,방법,구조 기,구성원 속성 을 책임 집 니 다.JDK 가 제공 하 는 도구 인 javadoc 에서 해석 할 수 있 으 며,프로그램 설명 문 서 를 웹 파일 로 표시 하 는 설명 을 자동 으로 생 성 합 니 다.
메모:문서 설명 은 클래스,인터페이스,방법,구조 기,구성원 필드 앞 에 써 야 합 니 다.다른 위치 에 쓰 면 유효 하지 않 습 니 다.
JavaDoc 공식 설명
How to Write Doc Comments for the Javadoc Tool
클래스 에 적 힌 자바 독
클래스 에 적 힌 문서 표 시 는 일반적으로 세 단락 으로 나 뉜 다.
4.567917.첫 번 째 부분:개요 설명 은 보통 한 마디 또는 한 마디 로 이런 역할 을 간략하게 묘사 하고 영어 마침 표를 끝으로 끝난다4.567917.두 번 째 단락:상세 한 설명 은 보통 한 단락 또는 여러 단락 의 말로 이런 역할 을 상세 하 게 묘사 하 는데 보통 모든 단락 의 말 은 영문 마침 표를 끝으로 끝난다
  • 세 번 째 단계:문서 레이 블 은 작성 자,생 성 시간,참조 류 등 정 보 를 표시 하 는 데 사 용 됩 니 다
  • 개요 설명
    단일 줄 예제:
    
    package org.springframework.jdbc.core;
    /**
     * Simple adapter for {@link PreparedStatementSetter} that applies a given array of arguments.
     *
     */
    public class ArgumentPreparedStatementSetter implements PreparedStatementSetter, ParameterDisposer {
    }
    
    여러 줄 예제:
    
    package java.lang;
    /**
     * The {@code Long} class wraps a value of the primitive type {@code
     * long} in an object. An object of type {@code Long} contains a
     * single field whose type is {@code long}.
     *
     * <p> In addition, this class provides several methods for converting
     * a {@code long} to a {@code String} and a {@code String} to a {@code
     * long}, as well as other constants and methods useful when dealing
     * with a {@code long}.
     *
     * <p>Implementation note: The implementations of the "bit twiddling"
     * methods (such as {@link #highestOneBit(long) highestOneBit} and
     * {@link #numberOfTrailingZeros(long) numberOfTrailingZeros}) are
     * based on material from Henry S. Warren, Jr.'s <i>Hacker's
     * Delight</i>, (Addison Wesley, 2002).
     *
     * @author  Lee Boynton
     * @author  Arthur van Hoff
     * @author  Josh Bloch
     * @author  Joseph D. Darcy
     * @since   JDK1.0
     */
    public final class Long extends Number implements Comparable<Long> {
    }
    
    주석 에@으로 시작 하 는 동 동 은 자바 doc 문서 태그 라 고 불 리 며 JDK 가 정의 한@author,@version,@since,@see,@link,@code,@param,@return,@exception,@throws 등 입 니 다.
    @link:{@link 패키지 이름.클래스 이름\#방법 명(매개 변수 유형)}관련 코드 에 빠르게 연결 하 는 데 사용 합 니 다.
    @link 는 문법{@link 패키지 이름 을 사용 합 니 다.클래스 이름\#방법 이름(매개 변수 유형)}을 사용 합 니 다.패키지 이름 이 현재 클래스 에 가 져 왔 을 때 생략 할 수 있 습 니 다.클래스 이름 일 수도 있 고 하나의 방법 이름 일 수도 있 습 니 다.방법 이름 은 이 문서 에 표 시 된 클래스 나 방법 을 사용 합 니 다.Ctrl 키+마 우 스 를 누 르 고 해당 클래스 나 방법 으로 빠르게 이동 할 수 있 습 니 다.html 로 해석 하 는 것 은 사실패키지 이름 을 사용 하 는 것 입 니 다.클래스 이름\#방법 명(매개 변수 유형)@link 예제
    
    //        
    {@link java.nio.charset.CharsetEncoder}
    //     
    {@link String} and {@link StringBuilder}
    //     ,           
    {@link #equals(Object)}
    //   .  #   (    )
    {@link java.lang.Long#toString(long)} 
    
    @code:{@codetext}텍스트 를 code 로 표시 합 니 다.
    @code 의 사용 문법{@codetext}은text로 해 석 됩 니 다.
    텍스트 를 코드 스타일 로 표시 하 는 텍스트 는 code 내부 에서<,>등 html 태그 로 해석 되 지 않 습 니 다.code 라벨 은 자신의 스타일 이 있 습 니 다.
    일반적으로 자바 doc 에 서 는 클래스 이름 이나 방법 명 만 언급 되면@code 로 표시 해 야 합 니 다.
    2 단:상세 설명
    상세 한 설명 은 보통 한 단락 또는 여러 단락 으로 클래스 의 역할 을 상세 하 게 설명 합 니 다.상세 한 설명 에 서 는 html 라벨 을 사용 할 수 있 습 니 다.예 를 들 어

    ,

    ,,

    좋은 웹페이지 즐겨찾기