자바 Doc 문서 작성

2627 단어 htmlJ#
자바 원본 파일 에 서 는 다음 조건 을 만족 시 켜 야만 자바 Doc 문 서 를 생 성 할 수 있 습 니 다.

  •      
    텍스트 주석 만 자바 독 문 서 를 생 성 할 수 있 습 니 다. 즉, '/*' 로 시작 하고 '*/' 로 끝 나 는 주석 입 니 다.

  •     
    자바 원본 파일 에 서 는 클래스 성명, 인터페이스 성명, 구성원 방법 성명, 구성원 변수 성명 및 구조 방법 이전의 설명 이 자바 Doc 문 서 를 생 성 할 수 있 으 며, 다른 곳 의 설명 은 무시 합 니 다.

  • 다음은 하나의 예 이다.
    /**
     *     JavaDoc     。
     * 
     */
    package com.fengyun.bam.part1;
    
    /**
     * <p><strong>JavaDocDemo</strong>      JavaDoc  </p>
     *       
     * @author administrator
     * @version 3.0
     * @since 1.0
     * @see com.fengyun.bam.part1.Bank
     */
    public class JavaDocDemo {
    	/**
    	 *          
    	 */
    	public String i ;
    	
    	/**
    	 *          
    	 */
    	public JavaDocDemo() {
    		this.i="Hello,world!";
    	}
    	/**
    	 *          
    	 * @param name     
    	 * @return      
    	 * @deprecated         
    	 * @since 2.0
    	 * @exception     
    	 */
    	public JavaDocDemo output(String name) {
    		System.out.println(name+",\t"+i);
    		return null;
    	}
    	public static void main(String[] args) {
    		JavaDocDemo j=new JavaDocDemo();
    		j.output("Lily");
    	}
    }
    

     
             부분 변수의 주석, 키워드 package 이전의 주석 등 은 무 시 됩 니 다.
         주석 에는 일반 텍스트, HTML 태그, 자바 Doc 태그 가 포함 되 어 있 습 니 다.

  • @ version 은 이 프로그램의 버 전 을 가 리 킵 니 다.

  • @ since 는 프로그램 코드 가 가장 먼저 어느 버 전에 나 타 났 는 지 알려 줍 니 다.클래스 의 구성원 변수 와 구성원 방법 에 대해 서 는 기본 적 인 상황 에서 클래스 의 최초 버 전에 서 나 타 났 다 고 가정 하 는 것 이 관례 입 니 다. 그렇지 않 으 면 @ since 로 최초 로 나 타 났 던 버 전 을 명 확 히 밝 히 는 것 입 니 다.

  • @ deprecated 는 주석 되 어 있 는 클래스, 변수, 방법 이 권장 되 지 않 음 을 나타 내 는 데 사 용 됩 니 다.

  • @ see 는 다른 자바 Doc 문 서 를 참고 하 는 연결 을 만 드 는 데 사 용 됩 니 다.

  •                   다른 종류의 자바 Doc 문 서 를 연결 하려 면 완전한 클래스 이름 을 제시 해 야 합 니 다.예: @see com.fengyun.bam.exception.ATMException
                      현재 클래스 의 방법 이나 변 수 를 연결 하 는 자바 Doc 문서, 예 를 들 어 @ see\# output
                      다른 종류의 방법 이나 변 수 를 연결 하 는 자바 Doc 문서, 예 를 들 어 @ see com. fengyun. bam. exception. ATM Exception\# output

  • @ link 는 주석 문 에 있 는 특정한 어휘 로 링크 를 생 성 합 니 다. 예 를 들 어/* * 이것 은 클래스 의 (@ link\# i 구성원 변수 곶 입 니 다. */

  • @ param 설명 방법의 인자 입 니 다.

  • @ return 설명 방법의 반환 값 입 니 다.

  • @exception、@throws  설명 방법의 이상 을 던 져 서 던 진 조건 을 가리킨다.

  • 좋은 웹페이지 즐겨찾기