javaDoc

简介: 以/**开头,以*/结尾的内容叫作javaDoc。 它可以放在类的定义前,也可以放在方法或字段的定义前。 例如/**RestTemplate使用方法示例 * @see org.springframework.web.client.RestTemplate */public class MyClient {}若类B在另一个源文件中,它调用了MyClient类,那么在ide中,鼠标

以/**开头,以*/结尾的内容叫作javaDoc。

它可以放在类的定义前,也可以放在方法或字段的定义前。

例如
/**RestTemplate使用方法示例
 * @see org.springframework.web.client.RestTemplate
 */
public class MyClient {}

若类B在另一个源文件中,它调用了MyClient类,那么在ide中,鼠标放在调用处,就会有一个小浮窗展现javaDoc的内容。效果见图1:


图1:ide中的javaDoc

javaDoc支持html标签。除此之外,还有一些@开头的标签。

@see:表示链接到其他类、方法、字段的javaDoc。

目录
相关文章
|
1月前
|
IDE Java API
Javadoc的讲解使用
本文介绍了Javadoc工具的使用方法和常用标签,通过示例代码展示了如何为Java代码添加文档注释并使用Javadoc命令生成HTML格式的API文档。
15 0
|
11月前
javadoc @apiNote、@implSpe、@implNote不识别问题
javadoc @apiNote、@implSpe、@implNote不识别问题
104 0
|
11月前
javadoc-plugin
javadoc-plugin
49 0
|
Java API
JavaDoc
JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base
JavaDoc
|
Oracle Java 关系型数据库
无法使用 javadoc 等命令?
谈到 Java 就离不开 JRE(Java Runtime Environment),JDK(Java Development Kit) 中包含了 JRE 和 JVM(Java Virtual Machine),所以我们一般直接安装 JDK,安装 JDK 首先肯定是去Oracle官网下载适合自己的开发版本,然后将 JDK 安装到自定义位置。
无法使用 javadoc 等命令?
|
Java Android开发
javaDOC生成
javaDOC生成
106 0
|
编译器 C语言 Swift