Java 문서 주석을 사용하여 문서를 생성하는 방법은 무엇입니까?-java지도 시간-php.cn

Java에서는 한 줄 주석, 여러 줄 주석, 문서 주석의 3가지 유형의 주석을 지원한다는 것을 알고 있습니다. 그 주석이 어떻게 생겼는지 살펴보겠습니다.

//한 줄 주석

/*
Multi- 줄 댓글
*/

/ **
*@...
*....
*문서 설명
*/

아마도 많은 초보자들이 이해하지 못할 수도 있는데, 이런 댓글을 써서 무슨 소용이 있나요?

사실 초보자들은 코드의 양이 적어 주석 없이 빠르게 검색하고 수정할 수 있기 때문입니다.

코드가 점차 많아지면, 스스로 코드를 명확하게 볼 수 있을 뿐만 아니라, 주석이 좋은 것입니다. 다른 사람들과의 소통을 위해서도요. 함께 프로젝트를 진행하는 멤버들의 편의를 위한

댓글을 쓰지 않는 나쁜 습관도 버리세요! ! !

오늘의 주제는 다음과 같습니다. 문서 댓글이란 무엇인가요?

Javadoc은 Sun에서 제공하는 기술로, 프로그램 소스 코드에서 클래스, 메소드, 멤버 등의 주석을 추출하여 소스 코드와 일치하는 API 도움말 문서를 구성합니다. 즉, 프로그램을 작성할 때 특정 태그 집합을 주석으로 사용하기만 하면 프로그램을 작성한 후 Javadoc을 통해 동시에 프로그램의 개발 문서를 작성할 수 있습니다.

javadoc 명령은 API 문서를 생성하는 데 사용됩니다. 사용 방법: 명령줄을 사용하여 대상 파일이 있는 디렉터리에 javadoc + 파일 이름.java를 입력합니다.

얽힐 필요는 없습니다. 이 복잡한 이론을 이해하고, 이해하고, 더 깊이 들어가고, 바꾸고, 이해하려면 이론에 집착하는 것은 효과가 없습니다!

코드를 작성할 때 표준이 있습니다. 작성한 코드가 실행 가능하지만 엉망이라면 유지 관리가 어렵기 때문에 누구도 사용하려고 하지 않습니다. 따라서 코드는 단순한 프로그램이 아닙니다. 온라인 세상에서는 예술 작품이라고 부르고 싶습니다. 세심한 각인이 필요합니다

어떤 사람들은 그냥 주석이 아닌가? 이게 무슨 상관이야

하지만 이 문서 댓글은 다른 두 댓글과 같지 않습니다. 댓글에도 기준이 있습니다.

문서 주석 사양

형식:

클래스에 작성된 문서 주석은 일반적으로 세 문단으로 나뉩니다.

첫 번째 문단: 요약 설명, 일반적으로 수업의 기능을 간략하게 설명하는 문장이나 문단으로 구성되며, 영어 마침표를 마침표로

두 번째 문단: 자세한 설명, 일반적으로 클래스의 기능을 자세히 설명하기 위해 하나 이상의 문단을 사용합니다. 일반적으로 각 문단은 영어 마침표로 끝납니다.

세 번째 문단: 문서 주석, 클래스의 기능을 표시하는 데 사용됩니다. 작성자 및 작성 시간, 참조 클래스 및 기타 정보

여기에서 약간의 지식을 확장하고 싶습니다. Dos 명령 또는 IDE 도구를 사용하여 Doc 문서를 생성할 수 있습니다. 이 문서는 HTML 언어를 통해 실행되므로 몇 가지 간단한 HTML이 있습니다. 다음과 같은 코드를 사용할 수 있습니다.

line break

paragraph

(문단 앞에 작성됨)

예제 스타일 다이어그램 넣기:

Java 문서 주석을 사용하여 문서를 생성하는 방법은 무엇입니까?

@ 기호 사용

Doc을 작성하고 있습니다. 댓글을 달 때 /** 바로 뒤에 Enter를 누르면 다음 댓글 프레임과 일부 @ 기호가 자동으로 생성됩니다. 그러면 이 @ 기호는 무엇에 사용됩니까?

{@link}메서드의 매개변수에 대해 설명하며 일반적으로 메서드 설명에 사용됩니다. 메소드 주석에 일반적으로 사용되는 반환 값 유형에 대해 설명합니다. 생성 메소드에 나타날 수 없습니다다른 주제에 대한 링크 지정 직렬화 속성 설명writeObject() 및 writeExternal() 메서드를 통해 작성된 데이터 설명 ObjectStreamField 구성 요소 설명이 함수가 Since에 어떤 버전이 있었는지 표시합니다. @Exception 태그와 동일한 의미를 갖습니다.정적 필드여야 하는 상수 값을 표시합니다.@version info@부분 I have here is 영어로 @author Xiaojian과 같은 중국어를 쓸 수 있습니다Doc 문서 생성 방법 위에서 Doc 댓글을 작성하면 Doc 문서가 생성될 수 있다고 했는데 HTML 형식이므로 어떻게 생성하나요? 첫 번째: Dos 명령 생성 형식 설명:

태그	설명	예
@author	는 일반적으로 클래스 주석에 사용되는 클래스 작성자를 식별합니다.	@author 설명
@deprecated	디자인 만료된 클래스나 멤버를 먹은 경우 , 사용이 권장되지 않는 클래스 또는 메서드를 나타냅니다.	@deprecated 설명
{@docRoot}	현재 문서 루트 디렉터리의 경로를 나타냅니다.	디렉터리 경로
@Exception	에 대한 설명 발생할 수 있는 예외, 일반적으로 메서드 주석에 사용됩니다.	@Exception 예외 이름 설명
{@inheritDoc}	직접 상위 클래스에서 주석을 상속합니다.
in-line link 다른 주제에 대한 인라인 링크를 삽입합니다.		@param
@param 매개변수 이름 설명		@return
@return 설명		@see
@see 앵커		@serial
@serial 설명		@serialData
@serialData 설명		@serialField
@serialField 이름 유형 설명		@ Since
@since release		@throws
	{@value}	정적 속성이어야 하는 상수의 값을 표시합니다.
	@version	클래스 주석에 일반적으로 사용되는 클래스 버전을 지정합니다.

		javadoc [options] [packagenames] [sourcefiles]

options 는 Javadoc 명령의 옵션을 나타냅니다. >packagenames 는 패키지 이름을 나타내고

`sourcefiles` 는 소스 파일 이름을 나타냅니다.

cmd(명령 프롬프트)에 javadoc -help를 입력하면 볼 수 있습니다. ) Javadoc 사용법 및 옵션(JDK가 설치 및 구성되어 있는 경우), Javadoc 명령의 일반 옵션은 다음과 같습니다.

- protected

보호/공용 클래스 및 멤버 표시(기본값)

-package

options 表示 Javadoc 命令的选项；

packagenames 表示包名；

sourcefiles 表示源文件名;

在 cmd（命令提示符）中输入javadoc -help패키지/보호/공용 클래스 및 멤버 표시

-private모든 클래스 및 멤버 표시-d 출력 파일의 대상 디렉터리-version@version 세그먼트가 포함됨-author@author 세그먼트가 포함됨-splitindex분할 각 문자에 대한 색인 파일에 해당하는-windowtitle 문서의 브라우저 창 제목Eclipse나 IDEA를 사용하여 생성할 수 있습니다. 저는 Eclipse를 잘 사용하지 않습니다. IDEA를 사용하여 보여드리겠습니다. 도구의 JavaDoc에 입력하면 이런 모습입니다. Java의 인코딩이 다르므로 주의하세요. IDEA의 것이므로 다른 명령 매개변수 열에 다음 내용을 입력해야 합니다

-encoding utf8 -docencoding utf8 -charset utf8

로그인 후 복사







Doc으로 생성하는 것이 번거롭고 느린데 다른 방법이 있나요?	두 번째: IDE 도구 생성

	출력 디렉터리를 선택해야 합니다. 그렇지 않으면 생성되지 않습니다.
생성 후에는 다음과 같습니다