没有合适的资源?快使用搜索试试~ 我知道了~
JDK13-javadoc-guide.pdf
需积分: 5 0 下载量 108 浏览量
2023-08-08
07:31:24
上传
评论
收藏 367KB PDF 举报
温馨提示
试读
27页
JDK13-javadoc-guide
资源推荐
资源详情
资源评论
Java Platform, Standard Edition
Javadoc Guide
Release 13
F17441-02
October 2019
Java Platform, Standard Edition Javadoc Guide, Release 13
F17441-02
Copyright © 2014, 2019, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,
license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.
Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-
specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
Audience iv
Documentation Accessibility iv
Related Documents iv
Conventions iv
1
Javadoc
Javadoc Features 1-1
2
Source Files
3
Javadoc Command
Javadoc Doclets 3-1
Javadoc Doclet Options 3-1
Using the link Option 3-3
Using the linkoffline Option 3-5
Using the Tag Option 3-7
javadoc Command-Line Argument Files 3-9
The Standard Doclet 3-10
Javadoc Standard Doclet 3-10
Generated Files 3-12
Examples of Running the javadoc Command 3-15
iii
Preface
This guide provides information about using the
javadoc
command, its options, and
the Standard Doclet.
Audience
This document is intended for Javadoc tool users. Users who are developing Javadoc
content should also see the Documentation Comment Specification for the Standard
Doclet for detailed information required to create javadoc content.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.
Related Documents
• See JDK 13 Documentation.
• The Javadoc developers can refer to the Javadoc specifications.
Conventions
The following text conventions are used in this document:
Convention Meaning
boldface Boldface type indicates graphical user interface elements associated
with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for
which you supply particular values.
monospace
Monospace type indicates commands within a paragraph, URLs, code
in examples, text that appears on the screen, or text that you enter.
Preface
iv
1
Javadoc
The
javadoc
tool is a program that reads a collection of source files into an internal
form.
The structure is:
(source-files)->[javadoc-tool:doclet]->(generated files)
.
The Javadoc doclet is like a pluggable back end that analyzes this internal form with
some goal in mind. It can generate HTML, MIF, or XML files, depending on the doclet.
The content of the generated files is specific to the doclet. The standard doclet
generates HTML documentation, but a different doclet, for example, could generate a
report of misspelled words or grammatical errors.
If you specify a doclet other than the standard doclet, then the descriptions in this
guide might not apply to the operation of that doclet or the files (if any) that are
generated.
To use the
javadoc
tool, you must:
• Write source code, containing documentation comments. Documentation
comments are formatted in HTML and are interspersed with the
javadoc
tool.
• Run the
javadoc
tool. You need to specify a doclet to analyze the documentation
comments and any other special tags. However, if you don’t specify any doclet, by
default, the Standard Doclet is included. You specify a number of command-line
options, some of which are directed at the
javadoc
tool itself, and some of which
are specific to the selected doclet. The command-line help shows and
distinguishes the options for the tool that apply to the currently selected doclet.
When the standard doclet is used, the output generated by the standard doclet
consists of a series of HTML pages. If you specify a different doclet, then the
operation of that doclet and what files (if any) are generated may or may not be
equivalent to the standard doclet described in this guide.
Javadoc Features
Javadoc features include the following: Javadoc search, support for generating HTML5
output, support for documentation comments in module systems, and simplified Doclet
API.
Search
The
javadoc
tool runs the doclet that may generate output. The standard doclet
generates output that lets you search the generated documentation. A search box is
available on the generated APIs and provides the following:
• You can search for elements and additional key phrases defined in the API
• Results, including results that exactly match the entered characters followed by
results that contains the entered characters anywhere in the string. Multiple results
are displayed as simple scrolling lists below the search box. Results are
categorized as follows, for easier classification and appropriate user selection:
1-1
剩余26页未读,继续阅读
资源评论
weixin_40191861_zj
- 粉丝: 64
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 海信智能电视刷机数据 LED42K330X3D(0000) 生产用软件数据 务必确认机编一致 强制刷机 整机USB升级程序
- shujudaochuceshi
- learn-ruby.zip
- test111111111111111111
- face-detect.ipynb
- 以下是一些关于ACM(国际大学生程序设计竞赛)、NOI(全国青少年信息学奥林匹克竞赛)以及CSP(全国青少年信息学奥林匹克竞赛提
- 是一些电子设计竞赛(电赛)经验分享,包括备赛策略、项目管理、团队合作和比赛期间的注意事项
- 全能运行库修复工具DirectX Repair v4.1.0.30770
- las格式点云数据使用详解(附VS编译好的LAStools工具)
- KRPano插件一键解密大师1.4.0 (解压密码1234)
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功