Java 注释及API文档(Day4)

52 阅读1分钟

注释

定义 :源文件中用于解释、说明程序的文字

注释种类

单行注释

// 注释内容

多行注释

/*
注释文字
……
*/

文档注释(Java特有)

/**
@author 指定Java程序作者
@version 指定源文件版本
*/

作用: 文档注释内容可以被JDK提供的工具 javadoc 解析,生成一套以网页文档形式体现的该程序的说明文档

注释作用

  • 提升了程序的可读性
  • 调试程序的重要方法

单行注释与多行注释

  1. 对程序的代码进行解释说明
  2. 进行程序调试

说明:

  1. 单行注释与多行注释中声明的信息不参与编译,即:编译后声明的字节码文件中不包含单行注释和多行注释中的信息
  2. 多行注释不能嵌套使用

Java API文档

  • API: (应用程序编程接口)是Java提供的基本编程接口
  • Java语言提供了大量基础类,因此Oracle也为这些基础类提供了相应的说明文档,用于向开发者说明这些类该如何使用以及这些类中包含的方法