![剑指Java:核心原理与应用实践](https://wfqqreader-1252317822.image.myqcloud.com/cover/443/47500443/b_47500443.jpg)
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人
第2章 第一个Java程序:HelloWorld
2.3.3 文档注释
文档注释是比较特殊的,它是Java特有的一种注释形式,其注释内容可以被JDK提供的javadoc.exe文档工具解析,生成一套以网页文件形式体现的应用程序编程接口(Application Programming Interface,API)说明文档,这样其他人可以在不看源代码的情况下,通过API说明文档快速地了解程序。这里就不再单独演示javadoc命令的解析过程了。
文档注释的格式:
![](https://epubservercos.yuewen.com/BBFB00/26895744002143606/epubprivate/OEBPS/Images/txt002_60.jpg?sign=1738781212-yYjsd9ADIfsxrA93n7QE7oaCHVh1dwDu-0-7bdaad9762c93c35b5daee0ac54a7163)
说明:文档注释需要使用“/**”和“*/”将注释内容包含起来,注释内容可以是一行或多行文字。文档注释中通常会有一些“@author”和“@version”等注释标签,用以表示作者和版本等信息。文档注释一般放在类、接口、属性或方法的上方。
● /**:表示注释开始。
● */:表示注释结束。
示例代码:
![](https://epubservercos.yuewen.com/BBFB00/26895744002143606/epubprivate/OEBPS/Images/txt002_61.jpg?sign=1738781212-o7VtAYjz2BQTNT0sXKncPonWcqVS9Wmt-0-5a83618d74187e0f6ccb32417eedd8bc)
文档注释相对比较专业,大家暂时不用着急学习,等后面见多了源码中的文档注释,自然就会习惯和掌握了。