Java平台标准版Javadoc指南:JDK12
"JDK12-javadoc-guide.pdf" 这篇文档是关于Java Platform, Standard Edition (Java SE) 12的Javadoc指南,发布于2019年3月,编号F13799-01。Javadoc是Java编程语言的一个工具,用于从源代码注释中生成API文档。这个版本的指南详细介绍了如何在JDK 12中使用Javadoc来创建高质量、易于理解的API文档。 Javadoc主要知识点包括: 1. **Javadoc命令行选项**:Javadoc提供了一系列命令行选项,允许用户自定义生成文档的方式。例如,`-d`选项指定输出目录,`-classpath`用于指定类路径,`-author`和`-version`选项会显示作者和版本信息等。 2. **注释语法**:Javadoc注释使用`/** ... */`格式,可以放在类、接口、方法、变量等前面,用以描述它们的功能和用法。注释中可以包含`@param`, `@return`, `@throws`, `@deprecated`, `@see`等标签,这些标签提供了关于参数、返回值、异常和引用信息。 3. **@tags**:Javadoc中的特殊标记(@tags)用于提供特定的信息。比如,`@param`描述方法参数,`@return`描述方法返回值,`@exception`或`@throws`指明可能抛出的异常,`@author`列出作者,`@version`记录版本信息,`@since`指出从哪个版本开始添加,`@serialField`和`@serialData`用于序列化等。 4. **包文档**:Javadoc不仅为类和接口生成文档,还可以为整个包生成概述页面,通过`@package-info.java`文件来添加包级别的注释。 5. **HTML标签**:Javadoc支持HTML标签,允许在注释中嵌入格式化的文本、链接和其他HTML元素,以增强文档的可读性和实用性。 6. **链接与引用**:`@link`、`@linkplain`和`@serialField`等标签可用于创建到其他类、方法或字段的链接。`@see`则用于在文档中添加交叉引用,指向相关的类、方法或网页。 7. **样式和模板**:Javadoc可以通过定制模板和CSS样式表来自定义生成文档的外观和布局。 8. **多语种支持**:Javadoc支持多语言文档的生成,通过`-doclet`和`-docletpath`选项可以使用特定的Doclet实现。 9. **API注解**:JDK 12的Javadoc可能会涵盖新的API注解,这些注解提供了额外的元数据,可以被Javadoc解析并包含在生成的文档中。 10. **更新和改进**:每个新版本的JDK都会对Javadoc进行优化和增强,JDK 12可能会引入一些新的特性或修复已知问题,以提升用户体验和文档质量。 请注意,由于没有提供具体内容,以上内容是基于一般Javadoc指南的常见知识点总结。具体的JDK 12 Javadoc指南可能包含更多针对性的指导和示例。
![](https://csdnimg.cn/release/download_crawler_static/88184934/bg6.jpg)
剩余26页未读,继续阅读
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://profile-avatar.csdnimg.cn/28105908048e4518a28a3457cdef3389_weixin_40191861.jpg!1)
- 粉丝: 77
- 资源: 1万+
我的内容管理 展开
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助
![](https://csdnimg.cn/release/wenkucmsfe/public/img/voice.245cc511.png)
最新资源
- 岩石滑动与断层冲击地压:声发射特征分析
- 新时代煤炭工业八大战略新取向剖析
- 开采强度对华亭矿区冲击地压危险性的影响分析
- 新安煤矿探采对比:影响安全生产的关键因素与技术支撑
- 210MW循环流化床锅炉引风机变频改造优化与节能效果
- 浅埋煤层开采沉陷预测:方法应用与影响分析
- 优化巷道过陷落柱支护方案:数值模拟与现场试验
- 坚硬顶板定向断裂爆破技术:安全高效采煤新方案
- 北航2019算法课作业解析:投资策略与凸子多边形优化
- 断层破碎带垮冒下堆积体边界抗力分布关键影响因素
- 哈拉沟选煤厂优化末煤系统提高效率与处理能力
- 瓦斯涌出影响下采动煤体蠕变失稳研究
- 提升煤矿装载效率的可控箕斗定量装载设备设计
- 水分调控下烟煤瓦斯吸附特性对比研究
- 重介质悬浮液密度控制硬件设计与选型探讨
- 坚硬顶板巷道支护参数设计:现场测试与数值分析
![](https://img-home.csdnimg.cn/images/20220527035711.png)
![](https://img-home.csdnimg.cn/images/20220527035111.png)
![](https://csdnimg.cn/release/wenkucmsfe/public/img/green-success.6a4acb44.png)