Java平台标准版Javadoc指南，第9版，2017年9月发布

需积分: 5 19 浏览量更新于2024-01-30 收藏 308KB PDF 举报

The "JDK9-JSE-Javadoc Guide-43.pdf" is a comprehensive guide for the Java Platform, Standard Edition Javadoc, Release 9. It provides detailed information on how to use and navigate the Javadoc tool, which is used for generating API documentation in HTML format from doc comments in source code. The guide covers various aspects of Javadoc, including its syntax, tags, and usage. It also provides best practices for writing effective and clear documentation, as well as tips for using Javadoc with different programming languages and tools. One of the key features of the guide is its focus on the new features and improvements introduced in JDK9. It provides detailed explanations of the changes in Javadoc's functionality and syntax, as well as examples of how to leverage these changes to create better documentation for Java libraries and applications. The "JDK9-JSE-Javadoc Guide-43.pdf" is a valuable resource for both new and experienced Java developers who want to improve the quality of their code documentation. It is a comprehensive and authoritative guide that provides all the information needed to effectively use Javadoc for documenting Java APIs. Overall, the guide is well-organized and easy to follow, with clear examples and explanations. It is a valuable resource for anyone working with Java and looking to improve their code documentation practices. Whether you are a beginner or an experienced developer, this guide has something to offer for everyone.

Unprocessed Files

Your source files can include any files that you want the

javadoc

tool to copy to the

destination directory. These files usually include graphic files, example Java source

and class files, and self standing HTML files with a lot of content that would

overwhelm the documentation comment of a typical Java source file.

To include unprocessed files, put them in a directory called doc-files. The doc-

files directory can be a subdirectory of any package directory that contains source

files. You can have one

doc-files

subdirectory for each package.

Oracle Solaris, Linux, and macOS: For example, if you want to include the image of

a button in the

java.awt.Button

class documentation, then place the image file in the

home/user/src/java/awt/doc-files/

directory. Don't place the

doc-files

directory at

home/user/src/java/doc-files

, because

java

isn't a package. It doesn't contain any

source files.

Windows: For example, if you want to include the image of a button in the

java.awt.Button

class documentation, then place the image file in the

\src\java\awt

\doc-files

directory. Don't place the doc-files directory at

\src\java\doc-files

because

java

is not a package. It doesn't contain any source files.

All links to the unprocessed files must be included in the code because the

javadoc

tool doesn't look at the files. The

javadoc

tool copies the directory and all of its

contents to the destination. The following example shows how the link in the

Button.java

documentation comment might look:

/**

* <p> This button looks like this:</p>

* <img src="doc-files/Button.gif"/>

Test and Template Files

You can store test and template files in the source tree in the same directory with or in

a subdirectory of the directory where the source files reside. To prevent test and

template files from being processed, run the

javadoc

tool and explicitly pass in

individual source file names.

Test files are valid, compilable source files. Template files aren’t valid, compatible

source files, but they often have the

.java

suffix.

• Test Files : If you want your test files to belong to either an unnamed package or

to a package other than the package that the source files are in, then put the test

files in a subdirectory underneath the source files and give the directory an invalid

name. If you put the test files in the same directory with the source files and call

the

javadoc

tool with a command-line argument that indicates its package name,

then the test files cause warnings or errors. If the files are in a subdirectory with

an invalid name, then the test file directory is skipped and no errors or warnings

are issued. For example, to add test files for source files in com.package1, put

them in a subdirectory in an invalid package name. The following directory name

is invalid because it contains a hyphen:

– Oracle Solaris, Linux, and macOS:

com/package1/test-files/

– Windows:

com\package1\test-files\

If your test files contain documentation comments, then you can set up a separate

run of the

javadoc

tool to produce test file documentation by passing in their test

source file names with wild cards, such as

com/package1/test-files/*.java

Chapter 2

2-2

剩余42页未读，继续阅读

weixin_40191861_zj

粉丝: 84
资源: 1万+

Java平台标准版Javadoc指南，第9版，2017年9月发布

JDK10-JSE ,Installation Guide-57.pdf

jdk20--jdk-javadoc-guide.pdf

JDK9-JSE-Monitoring and Management Guide-67.pdf

JDK9-JSE-Deployment Guide-164.pdf

JDK9-JSE-Installation Guide-27.pdf

JDK9-JSE-JRockit to HotSpot Migration Guide-29.pdf

JDK9-JSE-Nashorn User's Guide-32.pdf

JDK10-JSE ,Java Virtual Machine Guide-70.pdf

JDK10-JSE JRockit to HotSpot Migration Guide-30.pdf

JDK10-JSE,Internationalization Guide-37.pdf

最新资源