java 核心技术-12版 卷Ⅰ- 4.10.6 包注释
mhr18 2024-12-19 11:01 19 浏览 0 评论
原文
4.10.6 包注释
可以直接将类、方法和变量的注释放置在 Java 源文件中，只要用 /** ... */文档注释界定就可以了。但是，要想产生包注释，就需要在每一个包目录中添加一个单独的文件。可以有如下两个选择:
- 提供一个名为 package-info.java 的 Java 文件。这个文件必须包含一个初始的 Javadoc 注释，以/**和*/界定，后面是一个 package 语句。它不能包含更多的代码或注释。
- 提供一个名为 package.html 的HTML 文件，抽取标记 body>...</body> 之间的所有文本
4.10.7 注释提取
在这里，假设你希望HTML 文件将放在名为 docDirectory 的目录下。执行以下步骤:
- 切换到源文件目录，其中包含想要生成文档的源文件。如果有嵌套的包要生成文档，例如： com.horstmann.corejava，就必须切换到包含子目录 com 的目录(如果提供 overview.html 文件的话，这就是这个文件所在的目录)。
- 如果是一个包，应该运行命令
javadoc -d docDirectory nameOfPackage
或者，如果要为多个包生成文档，运行:
javadoc -d docDirectory nameOfPackage1 nameOfPackage ...
如果你的文件在无名包中，则应该运行:
javadoc -d docDirectony *.java
如果省略了 -d docDirectory 选项，HTML 文件就会提取列当前目录下。这样可能很混乱，因此我不提倡这种做法。
可以使用很多命令行选项对 javadoc 程序进行微调。例如，可以使用 -author 和 -version 选项在文档中包含 @author 和 @version 标记(默认情况下，这些标记会被略)。另一个很有用的选项是 -link，用来为标准类添加超链接。例如，如果使用命令
javadoc -link http://docs.oracle.com/javase/9/docs/api *.java
那么，所有的标准类库的类都会自动地链接到 Oracle 网站的文档。
如果使用 -linksource 选项，那么每个源文件将会转换为 HITML(不对代码着色，但包含行号)，并且每个类和方法名将变为指向源代码的超链接。
还可以为所有源文件提供一个概要注释。把它放在一个类似 overview.html 的文件中，运行 javadoc 工具，并提供命令行选项 -overview filename。将抽取标记 body>...</body> 之间的所有文本。当用户从导航栏中选择“Overview”时，就会显示这些内容。
有关其他的选项，请查阅 javadoc 工具的联机文档 https://docs.oracle.com/javase/9/javadoc/javadoc.html
相关推荐
- SQL入门知识篇（sql入门新手教程视频）
-
一、什么是数据库？什么是SQL?1、数据库：存放数据，可以很多人一起使用2、关系数据库：多张表+各表之间的关系3、一张表需要包含列、列名、行4、主键：一列（或一组列），其值能够唯一区分表中的每个行。5...
- postgresql实现跨库查询-dblink的妙用
-
技术导语：用惯了oracle的dblink，转战postgresql，会一时摸不着头脑。本期就重点详细讲解postgresql如何安装dblink模块及如何使用dblink实现跨库查询。安装cont...
- Oracle VM VirtualBox虚拟机软件（oracle vm virtualbox win10）
-
OracleVMVirtualBox是一款完全免费的虚拟机软件，下载银行有提供下载，软件支持安装windows、linux等多个操作系统，让用户可以在一台设备上实现多个操作系统的操作。同时软件有着...
- 开源 SPL 轻松应对 T+0（开源srs）
-
T+0问题T+0查询是指实时数据查询，数据查询统计时将涉及到最新产生的数据。在数据量不大时，T+0很容易完成，直接基于生产数据库查询就可以了。但是，当数据量积累到一定程度时，在生产库中进行大数据...
- 中小企业佳选正睿ZI1TS4-4536服务器评测
-
随着科技的不断发展，各行各业对于数据使用越加频繁，同时针对服务器的选择方面也就越来越多样化和细分化。那么对于我们用户来说，如何选择符合自身业务需求和最优性价比的产品呢？笔者将通过刚刚购买的这台服务器的...
- MFC转QT:Qt基础知识（mfc和qt的区别）
-
1.Qt框架概述Qt的历史和版本Qt是一个跨平台的C++应用程序开发框架，由挪威公司Trolltech（现为QtCompany）于1991年创建。Qt的发展历程：1991年：Qt项目启动1995年...
- 数据库，QSqlTableModel（数据库有哪些）
-
QMYSQL——mysqlQSQLITE——sqliteQOICQ——orcale所需头文件.pro增加sql#include<QSqlDatabase>#include<Q...
- python通过oledb连接dbf数据库（python连接jdbc）
-
起因：因为工作需要，需要读取dbf文件和系统数据中数据进行校对，因为知道dbf文件可以用sql查询，所以想能不能像mysql/oracle那样连接，再调用执行sql方法，通过一系列百度，尝试，最终通过...
- Excel常用技能分享与探讨(5-宏与VBA简介 VBA与数据库)
-
在VBA（VisualBasicforApplications）中使用数据库（如Access、SQLServer、MySQL等）具有以下优点，适用于需要高效数据管理和复杂业务逻辑的场景：1....
- Excel常用技能分享与探讨(5-宏与VBA简介 VBA与数据库-二)
-
以下是常见数据库软件的详细配置步骤，涵盖安装、驱动配置、服务启动及基本设置，确保VBA能够顺利连接：一、MicrosoftAccess适用场景：小型本地数据库，无需独立服务。配置步骤：安装Acces...
- Windows Docker 安装（docker安装windows容器）
-
Docker并非是一个通用的容器工具，它依赖于已存在并运行的Linux内核环境。Docker实质上是在已经运行的Linux下制造了一个隔离的文件环境，因此它执行的效率几乎等同于所部署的L...
- Windows下安装Ubuntu虚拟机方法（windows下安装ubuntu20）
-
在Windows下安装Ubuntu虚拟机。选择使OracleVMVirtualBox安装Ubuntu虚拟机。1.下载和安装OracleVMVirtualBox：访问OracleVMVir...
- java入门教程1 - 安装和配置(win和linux)
-
windows安装和配置安装javahttps://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html目前大部分项目的...
- Centos7 安装Tomcat8服务及配置jdk1.8教程
-
1、下载jdk1.8压缩包下载地址：https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.htmltom...
- 全网最完整的免费java教程讲义(一)——java配置和安装
-
一，安装Java1)安装JDK要学习和使用java，首先需要安装JDK(JavaDevelopemntKit)，相当于java安装包。Java的下载页在甲骨文官网上：https://www.or...
欢迎 你 发表评论:
- 一周热门
- 最近发表
-
- SQL入门知识篇（sql入门新手教程视频）
- postgresql实现跨库查询-dblink的妙用
- Oracle VM VirtualBox虚拟机软件（oracle vm virtualbox win10）
- 开源 SPL 轻松应对 T+0（开源srs）
- 中小企业佳选正睿ZI1TS4-4536服务器评测
- MFC转QT:Qt基础知识（mfc和qt的区别）
- 数据库，QSqlTableModel（数据库有哪些）
- python通过oledb连接dbf数据库（python连接jdbc）
- Excel常用技能分享与探讨(5-宏与VBA简介 VBA与数据库)
- Excel常用技能分享与探讨(5-宏与VBA简介 VBA与数据库-二)
- 标签列表
-
- oracle位图索引 (63)
- oracle批量插入数据 (62)
- oracle事务隔离级别 (53)
- oracle 空为0 (50)
- oracle主从同步 (55)
- oracle 乐观锁 (51)
- redis 命令 (78)
- php redis (88)
- redis 存储 (66)
- redis 锁 (69)
- 启动 redis (66)
- redis 时间 (56)
- redis 删除 (67)
- redis内存 (57)
- redis并发 (52)
- redis 主从 (69)
- redis 订阅 (51)
- redis 登录 (54)
- redis 面试 (58)
- 阿里 redis (59)
- redis 搭建 (53)
- redis的缓存 (55)
- lua redis (58)
- redis 连接池 (61)
- redis 限流 (51)