javadoc 사양 소개

소개:

우리는 javadoc이 JDK에 포함되어 있다는 것을 알고 있으므로 javadoc 사양을 따르는 것은 확실히 Java 주석의 정통입니다. API 문서를 생성하는 데 도움이 되는 javadoc을 갖는 것은 매우 실용적입니다.

(학습 영상 공유: java 영상 튜토리얼)

1. 댓글이란 무엇인가요?

댓글은 코드의 가독성을 높이고 팀워크의 커뮤니케이션 비용을 줄이기 위한 것입니다. 팀에서 코드가 더 명확하고 읽기 쉽고 표준화되면 더 많은 사람들과 호환될 수 있기 때문에 승진과 급여 인상은 확실히 당신의 것입니다.
얼마 전에 이런 말을 들었습니다. 코드를 이해할 수만 있다면 당신은 없어서는 안 될 사람입니다. 이런 말을 한 사람은 자기가 작성한 코드를 읽고 이해할 수 있는 사람입니다. 아무도 그를 보고 싶어하지 않습니다.

2. 자주 사용되는 댓글 단축키

라인 주석 달기: //나는 해당 라인의 내용입니다.
단축키: ctrl+/ 역연산: ctrl+/블록 댓글 달기: /*나는 블록의 내용입니다*/
단축키: ctrl+shift+/ 역연산: ctrl+shift+javadoc 인식 가능한 설명:

	/**
	 * 我是注释
	 * 我也是注释
	 * 我还是注释，我们都能被javadoc识别
	 */

3. Javadoc 사양

javadoc 사양에 따라 javadoc 명령을 사용하여 매우 직관적이고 읽기 쉬운 코드를 생성할 수 있습니다. 매우 편리한 API 문서입니다.
우리가 프로그램에 표시하는 주석은 의식적으로 두 가지 유형으로 나눌 수 있습니다. 하나는 우리가 읽기 위한 간단한 주석이고, 다른 하나는 읽기 쉬운 문서 생성을 목적으로 하는 javadoc 사양을 준수하는 주석입니다.
생성된 API 문서를 주의 깊게 읽어보세요. 그림과 같이 설명해야 할 세 부분이 있습니다.

위의 빨간색 상자 내용은 제가 추가한 설명입니다. 간단한 Hello 클래스의 소스 코드는 다음과 같습니다. 관심이 있으시면 직접 시도해 볼 수 있습니다.

/**
  *	@author XXXX
  *	@version 创建时间：2021年1月21日 下午3:22:01
  *	
  */
public class Hello {

	/**
	 * main()方法简述(后面这个dot必不可少).
	 * <p>这就是为了测试注释<br>
	 * 没什么好说明的，只为了说明能出现在这里
	 * @param args 就是系统配的，没啥说的
	 * 
	 */
	public static void main(String[] args) {
//		 TODO Auto-generated method stub
		System.out.println("hello");	

	}
	
	/**
	 * havaReturn方法就是为了测试javadoc注释规范的.
	 * <p>我发现只有有返回值的方法才可以使用return标签<br>
	 * 没有return硬是要用，只会在javadoc时候报错
	 * @param a 输入的第一个int类型的参数
	 * @param b 输入的第二个int类型的参数
	 * @return add 两个数的和运算结果
	 */
	public int haveReturn(int a,int b){
		int add=0;
		add=a+b;
		return add;
	}

}

몇 가지 짚고 넘어가야 할 점이 있습니다.

저작자와 버전을 표시하려면 API 문서의 경우 프로그램 주석에 @author 및 @version을 추가해야 할 뿐만 아니라 프로그램에서 이 위치의 @author 주석은 최종 문서에 한 번만 표시된다는 점에 유의해야 합니다. 주석만 달 것을 권장합니다.
javadoc -d 폴더 -version -author Hello.java
여기서 -d 폴더는 생성된 API 문서(실제로 많은 웹 페이지로 구성됨)를 폴더 폴더 물론 폴더도 경로가 될 수 있습니다

방법 요약과 방법 세부 정보를 어떻게 구분하나요?

/**
	 * main()方法简述(后面这个dot必不可少).
	 * <p>这就是为了测试注释<br>
	 * 没什么好说明的，只为了说明能出现在这里
	 * @param args 就是系统配的，没啥说的
	 * 
	 */
	public static void main(String[] args) {
//		 TODO Auto-generated method stub
		System.out.println("hello");	

	}

메서드에 대한 댓글이 많다는 걸 아셨을 텐데요. javadoc은 어떻게 요약을 추출하나요? 맞습니다. 점(.) 하나만 의지하고 제 댓글에 언급된 점을 관찰하세요. 그것이 요약 추출의 핵심입니다. 점 앞에는 요약이 있고, 모든 것이 상세한 소개입니다(상세 소개에는 요약이 포함됩니다). )

생성된 문서에서 주석 형식을 제어하는 ​​방법
프로그램에서 제어할 수 있는 것은 주석 형식이지만 이러한 형식의 형식은 javadoc에서 인식되지 않습니다. 생성된 문서는 HTML 형식이므로 프로그램에서 HTML 구문에 주석을 달면 API 문서 형식을 편집할 수 있으므로 걱정하지 마세요. , 단락

, 줄바꿈
과 같은 몇 가지 간단한 HTML 구문을 사용하기 때문에 이것으로 충분하므로 주석이 그다지 길지 않습니다.

@param 매개변수 1 설명(형식 주의)

@return 반환 값 설명(형식 주의)
반환 값이 있으면 쓰지 않습니다. 작성해야 합니다.

실제로 클래스 주석과 메서드 주석을 작성하는 방법은 매우 간단합니다. 클래스나 메서드 앞에 /**를 누르고 Enter를 누르면 시스템이 작동합니다. 자동으로 추가되며, 시스템이 추가하는 방식도 저희가 수정할 수 있습니다

새 파일 생성 시 나타나는 내용을 수정하는 방법, 자동 추가하는 방법 모든 주석은 저희가 관리합니다(할일)

우리는 표준 클래스 파일에서 이것을 볼 수 있습니다:

out은 PrintStream 클래스에 있는 System 클래스의 속성(필드)이라는 것을 모두 알고 있습니다. 많은 메소드가 정의되어 있으며 이들은 자연스럽게 out 메소드입니다. 따라서 out을 정의할 때 앞의 주석에 @see가 많이 있습니다. 이는 클래스의 필드를 정의할 때 필드가 복합 유형인 경우( 특히 사용자 정의 복합 유형) 앞에 @see를 댓글로 달아 주세요. 두 가지 이점이 있습니다. 그림을 참조하세요.

이 두 그림은 익숙하시리라 믿습니다. 첫 번째 그림은 프로그램 작성 시 커서를 가리키면 나타나는 프롬프트입니다. javadoc 사양에 따라 주석을 작성하면 프로그램에도 나타납니다. 글을 쓰는데 매우 도움이 되는 팁입니다. 두 번째는 Java8 API 문서의 String 클래스에 있는 out 필드에 대한 자세한 설명입니다. @see라고 썼는데, 자신의 프로젝트 API 문서에도 그런 주석이 있습니다.

관련 권장 사항: Java 입문 튜토리얼

위 내용은 javadoc 사양 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!