JavaDoc【注释】生成API(开发文档)详解

一、综述(类注释及方法注释)

1.1 简介

Javadoc 是 Java 自带的一种工具,其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标记【Tag】作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
Java中有三种注释方法:

  • //被注释语句
  • /*被注释语句*/
  • /**被注释语句*/

其中第三种专为 JavaDoc 设计,可以被 JDK 内置的 Javadoc 工具支持和处理。
Javadoc在命令行使用还是比较复杂的,在Eclipse、IntelliJ IDEA等IDE中却比较方便,在命令行使用的麻烦的原因是众多的参数。

但是IDE傻瓜型的操作在有些时候还完成不了想要的任务。这时候,就需要懂得一些参数命令的用法了。
生成 Javadoc 不要求你的Java代码是可编译的,唯一要求的是存在.java文件。

官方提供API帮助文档:


版权声明:本文为kertnudserf56968原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。