文档注释与API文档

文档注释(Java特有)

格式:
/**
  @author 指定java程序的作者
  @version 指定源文件的版本
*/
比较:
  • 单行和多行注释
    注释内容不会参与编译,进而不会出现在.class字节码文件中,不会被JVM(java虚拟机)解释执行。
    作用: 增加程序的可读性;协助调试程序;
    备注: 多个多行注释不可嵌套使用
  • 文档注释
    注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。
    操作方式:
    命令行窗口定位到HelloWorld.java所在目录,执行以下命令,在该目录下生成一个叫mydoc的文件夹,里面的index.html即为该类的说明文档。

javadoc -d mydoc -author -version HelloWorld.java

正确的注释和注释风格
  • 使用文档注释来注释整个类或整个方法
  • 使用单行或多行注释来注释方法中的某一个步骤

Java的API文档

API (Application Programming Interface,应用程序编程接口)是 Java 提供的基本编程接口。Java语言提供了大量的基础类,因此 Oracle 也为这些基础类提供了相应的API文档,用于告诉开发者如何使用这些类,以及这些类里包含的方法。这些API文档就是通过文档注释生成的。
下载API:
下载地址:https://www.oracle.com/java/technologies/javase-downloads.html
-->Java SE 8u241-->Documentation Download-->下载jdk-8u241-docs-all.zip-->docs-->api-->index.html-->如下图(左上角:包列表区; 左下角:类列表区; 右侧:详细说明区)

API文档.png

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容