Java文档注释用法以及JavaDoc的使用说明

tangjin

作者

本篇内容介绍了“Java文档注释用法以及JavaDoc的使用说明”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！

简介

文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现该程序说明文档的注释。

注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。

JavaDoc 官方说明

How to Write Doc Comments for the Javadoc Tool

写在类上面的JavaDoc

写在类上的文档标注一般分为三段：

第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者、创建时间、参阅类等信息

第一段：概要描述

单行示例：

packageorg.springframework.jdbc.core;
/**
*Simpleadapterfor{@linkPreparedStatementSetter}thatappliesagivenarrayofarguments.
*
*/
publicclassArgumentPreparedStatementSetterimplementsPreparedStatementSetter,ParameterDisposer{
}

多行示例：

packagejava.lang;
/**
*The{@codeLong}classwrapsavalueoftheprimitivetype{@code
*long}inanobject.Anobjectoftype{@codeLong}containsa
*singlefieldwhosetypeis{@codelong}.
*
*<p>Inaddition,thisclassprovidesseveralmethodsforconverting
*a{@codelong}toa{@codeString}anda{@codeString}toa{@code
*long},aswellasotherconstantsandmethodsusefulwhendealing
*witha{@codelong}.
*
*<p>Implementationnote:Theimplementationsofthe"bittwiddling"
*methods(suchas{@link#highestOneBit(long)highestOneBit}and
*{@link#numberOfTrailingZeros(long)numberOfTrailingZeros})are
*basedonmaterialfromHenryS.Warren,Jr.'s<i>Hacker's
*Delight</i>,(AddisonWesley,2002).
*
*@authorLeeBoynton
*@authorArthurvanHoff
*@authorJoshBloch
*@authorJosephD.Darcy
*@sinceJDK1.0
*/
publicfinalclassLongextendsNumberimplementsComparable<Long>{
}

在注释中出现以@开头的东东被称之为Javadoc文档标记，是JDK定义好的如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等。

@link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码

@link的使用语法{@link 包名.类名#方法名(参数类型)}，其中当包名在当前类中已经导入了包名可以省略，可以只是一个类名，也可以是仅仅是一个方法名，也可以是类名.方法名，使用此文档标记的类或者方法，可用按住Ctrl键+鼠标单击快速跳到相应的类或者方法上，解析成html其实就是使用<code>包名.类名#方法名(参数类型)</code>

@link示例

//完全限定的类名
{@linkjava.nio.charset.CharsetEncoder}
//省略包名
{@linkString}and{@linkStringBuilder}
//省略类名，表示指向当前的某个方法
{@link#equals(Object)}
//包名.类名#方法名(参数类型)
{@linkjava.lang.Long#toString(long)}

@code： {@code text} 将文本标记为code

@code的使用语法{@code text} 会被解析成<code>text</code>

将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式

一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

第二段：详细描述

详细描述一般用一段或多段来详细描述类的作用，详细描述中可以使用html标签，如<p>、<pre>、<a>、<ul>、<i> 等标签，通常详细描述都以段落p标签开始。

详细描述和概要描述中间通常有一个空行来分割，实例如下

packageorg.springframework.util;
/**
*Miscellaneous{@linkString}utilitymethods.
*
*<p>Mainlyforinternalusewithintheframework;consider
*<ahref="http://commons.apache.org/proper/commons-lang/"rel="externalnofollow"rel="externalnofollow">Apache'sCommonsLang</a>
*foramorecomprehensivesuiteof{@codeString}utilities.
*
*<p>Thisclassdeliverssomesimplefunctionalitythatshouldreallybe
*providedbythecoreJava{@linkString}and{@linkStringBuilder}
*classes.Italsoprovideseasy-to-usemethodstoconvertbetween
*delimitedstrings,suchasCSVstrings,andcollectionsandarrays.
*
*@authorRodJohnson
*@authorJuergenHoeller
*@authorKeithDonald
*@authorRobHarrop
*@authorRickEvans
*@authorArjenPoutsma
*@authorSamBrannen
*@authorBrianClozel
*@since16April2001
*/
publicabstractclassStringUtils{}

一般段落都用p标签来标记，凡涉及到类名和方法名都用@code标记，凡涉及到组织的，一般用a标签提供出来链接地址。

@param

一般类中支持泛型时会通过@param来解释泛型的类型

packagejava.util;
/**
*@param<E>thetypeofelementsinthislist
*
*/
publicinterfaceList<E>extendsCollection<E>{}

@author

详细描述后面一般使用@author来标记作者，如果一个文件有多个作者来维护就标记多个@author，@author后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)

//纯文本作者
@authorRodJohnson
//纯文本作者，邮件
@authorIgorHersht,igorh@ca.ibm.com
//超链接邮件纯文本作者
@author<ahref="mailto:ovidiu@cup.hp.com"rel="externalnofollow">OvidiuPredescu</a>
//纯文本邮件
@authorshane_curcuru@us.ibm.com
//纯文本组织
@authorApacheSoftwareFoundation
//超链接组织地址纯文本组织
@author<ahref="https://jakarta.apache.org/turbine"rel="externalnofollow">ApacheJakartaTurbine</a>

@see 另请参阅

@see 一般用于标记该类相关联的类,@see即可以用在类上，也可以用在方法上。

/**
*@seeIntStream
*@seeLongStream
*@seeDoubleStream
*@see<ahref="package-summary.html"rel="externalnofollow">java.util.stream</a>
*/
publicinterfaceStream<T>extendsBaseStream<T,Stream<T>>{}

@since 从以下版本开始

@since 一般用于标记文件创建时项目当时对应的版本，一般后面跟版本号，也可以跟是一个时间，表示文件当前创建的时间

packagejava.util.stream;
/**
*@since1.8
*/
publicinterfaceStream<T>extendsBaseStream<T,Stream<T>>{}

packageorg.springframework.util;
/**
*@since16April2001
*/
publicabstractclassStringUtils{}

@version 版本

@version用于标记当前版本，默认为1.0

packagecom.sun.org.apache.xml.internal.resolver;
/**
*@version1.0
*/
publicclassCatalogManager{}

写在方法上的JavaDoc

写在方法上的文档标注一般分为三段：

第一段：概要描述，通常用一句或者一段话简要描述该方法的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注参数、返回值、异常、参阅等

方法详细描述上经常使用html标签，通常都以p标签开始，而且p标签通常都是单标签，不使用结束标签，其中使用最多的就是p标签和pre标签,ul标签, i标签。

pre标签可定义预格式化的文本。被包围在pre标签中的文本通常会保留空格和换行符。而文本也会呈现为等宽字体，pre标签的一个常见应用就是用来表示计算机的源代码。

一般p经常结合pre使用，或者pre结合@code共同使用(推荐@code方式)

一般经常使用pre来举例如何使用方法

注意：pre标签中如果有小于号、大于号、例如泛型在生产javadoc时会报错

p结合pre使用

/**
*Checkthatthegiven{@codeCharSequence}isneither{@codenull}nor
*oflength0.
*<p>Note:thismethodreturns{@codetrue}fora{@codeCharSequence}
*thatpurelyconsistsofwhitespace.
*<p><preclass="code">
*StringUtils.hasLength(null)=false
*StringUtils.hasLength("")=false
*StringUtils.hasLength("")=true
*StringUtils.hasLength("Hello")=true
*</pre>
*@paramstrthe{@codeCharSequence}tocheck(maybe{@codenull})
*@return{@codetrue}ifthe{@codeCharSequence}isnot{@codenull}andhaslength
*@see#hasText(String)
*/
publicstaticbooleanhasLength(@NullableCharSequencestr){
	return(str!=null&&str.length()>0);
}

pre结合@code使用

<pre>{@code
Person[]men=people.stream()
.filter(p->p.getGender()==MALE)
.toArray(Person[]::new);
}</pre>

@param

@param 后面跟参数名，再跟参数描述

/**
*@paramstrthe{@codeCharSequence}tocheck(maybe{@codenull})
*/
publicstaticbooleanhasText(@NullableCharSequencestr){
return(str!=null&&str.length()>0&&containsText(str));
}

@return

@return 跟返回值的描述

/**
*@return{@codetrue}ifthe{@codeCharSequence}isnot{@codenull},
*itslengthisgreaterthan0,anditdoesnotcontainwhitespaceonly
*/
publicstaticbooleanhasText(@NullableCharSequencestr){
return(str!=null&&str.length()>0&&containsText(str));
}

@throws

@throws 跟异常类型异常描述 , 用于描述方法内部可能抛出的异常

/**
*@throwsIllegalArgumentExceptionwhenthegivensourcecontainsinvalidencodedsequences
*/
publicstaticStringuriDecode(Stringsource,Charsetcharset){}

@exception

@exception 用于描述方法签名throws对应的异常

packagecom.sun.jmx.remote.security;
/**
*@exceptionLoginExceptionifthelogoutfails.
*/
publicbooleanlogout()throwsLoginException{}

@deprecated

@deprecated 用于标注一个类或成员已过期,通常配合{@link}使用

/**
*@deprecatedasof5.0.4,infavorof{@linkLocale#toLanguageTag()}
*/
@Deprecated
publicstaticStringtoLanguageTag(Localelocale){
returnlocale.getLanguage()+(hasText(locale.getCountry())?"-"+locale.getCountry():"");
}

@see

@see 既可以用来类上也可以用在方法上，表示可以参考的类或者方法

/**
*@seejava.net.URLDecoder#decode(String,String)
*/
publicstaticStringuriDecode(Stringsource,Charsetcharset){}

@value

{@value} 用于标注在常量上用于表示常量的值

/**默认数量{@value}*/
privatestaticfinalIntegerQUANTITY=1;

@inheritDoc

@inheritDoc 用于注解在重写方法或者子类上，用于继承父类中的Javadoc

基类的文档注释被继承到了子类
子类可以再加入自己的注释（特殊化扩展）
@return @param @throws 也会被继承

示例

spring-core中的StringUtils 示例

packageorg.springframework.util;
/**
*Miscellaneous{@linkString}utilitymethods.
*
*<p>Mainlyforinternalusewithintheframework;consider
*<ahref="http://commons.apache.org/proper/commons-lang/"rel="externalnofollow"rel="externalnofollow">Apache'sCommonsLang</a>
*foramorecomprehensivesuiteof{@codeString}utilities.
*
*<p>Thisclassdeliverssomesimplefunctionalitythatshouldreallybe
*providedbythecoreJava{@linkString}and{@linkStringBuilder}
*classes.Italsoprovideseasy-to-usemethodstoconvertbetween
*delimitedstrings,suchasCSVstrings,andcollectionsandarrays.
*
*@authorRodJohnson
*@authorJuergenHoeller
*@authorKeithDonald
*@authorRobHarrop
*@authorRickEvans
*@authorArjenPoutsma
*@authorSamBrannen
*@authorBrianClozel
*@since16April2001
*/
publicabstractclassStringUtils{
	/**
	*Checkthatthegiven{@codeCharSequence}isneither{@codenull}nor
	*oflength0.
	*<p>Note:thismethodreturns{@codetrue}fora{@codeCharSequence}
	*thatpurelyconsistsofwhitespace.
	*<p><preclass="code">
	*StringUtils.hasLength(null)=false
	*StringUtils.hasLength("")=false
	*StringUtils.hasLength("")=true
	*StringUtils.hasLength("Hello")=true
	*</pre>
	*@paramstrthe{@codeCharSequence}tocheck(maybe{@codenull})
	*@return{@codetrue}ifthe{@codeCharSequence}isnot{@codenull}andhaslength
	*@see#hasText(String)
	*/
	publicstaticbooleanhasLength(@NullableCharSequencestr){
		return(str!=null&&str.length()>0);
	}
}

亲自实践

packagecom.example.javadocdemo;
importjava.math.BigDecimal;
importjava.util.Objects;
/**
*类{@codeOrderService}订单服务层.
*
*<p>主要包括创建订单、取消订单、查询订单等功能更
*
*@seeOrder
*@author<ahref="mailto:lerryli@foxmail.com"rel="externalnofollow">LerryLi</a>
*@since2019/05/06
*/
publicclassOrderService{
/**默认数量{@value}*/
privatestaticfinalIntegerQUANTITY=1;
/**
*创建订单.
*
*<p>创建订单需要传用户id和商品列表(商品id和商品数量).
*
*<pre>{@code
*演示如何使用该方法
*List<Goods>items=newArrayList<>();
*Goodsgoods=newGoods(1L,BigDecimal.ONE);
*Goodsgoods2=newGoods(2L,BigDecimal.TEN);
*items.add(goods);
*items.add(goods2);
*
*Orderorder1=newOrder();
*order.setUserId("1");
*order.setItems(items);
*OrderService#createOrder(order);
*}
*</pre>
*
*@paramorder订单信息
*@throwsNullPointerException参数信息为空
*@exceptionIllegalArgumentException数量不合法
*@return是否创建成功
*@version1.0
*@seeOrder
*/
publicbooleancreateOrder(Orderorder)throwsIllegalArgumentException{
Objects.requireNonNull(order);
List<Goods>items=order.getItems();
items.forEach(goods->{
BigDecimalquantity=goods.getQuantity();
if(quantity==null||BigDecimal.ZERO.compareTo(quantity)==0){
thrownewIllegalArgumentException();
}
});
System.out.println("createorder...");
returntrue;
}
}

生成JavaDoc

通过IDEA生成Javadoc： Tools –> Generate JavaDoc

注意要配置编码，如果不配置则生成的JavaDoc会乱码，还需要配置Output directory

这里有几点要特别注意一下：

1、IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。

2、点击上述菜单项后，会出现生成 JavaDoc 的对话框，一般的选项都很直观，不必细说。但是要注意生成 JavaDoc 的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 Project 为 JavaDoc 生成的源范围。

3、里面有一个 Locale 可选填项，表示的是需要生成的 JavaDoc 以何种语言版本展示，根据 javadoc.exe 的帮助说明，这其实对应的就是 javadoc.exe 的 -locale 参数，如果不填，默认可能是英文或者是当前操作系统的语言，既然是国人，建议在此填写 zh_CN，这样生成的 JavaDoc 就是中文版本的，当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。

4、还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

-encoding UTF-8 -charset UTF-8 -windowtitle "JavaDoc使用详解" -link https://docs.oracle.com/javase/8/docs/api

5、第一个参数 -encoding UTF-8 表示你的源代码（含有符合 JavaDoc 标准的注释）是基于 UTF-8 编码的，以免处理过程中出现中文等非英语字符乱码；第二个参数 -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码，目前所有浏览器都支持 UTF-8，这样最具有通用性，支持中文非常好；第三个参数 -windowtitle 表示生成的 JavaDoc 超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容；第四个参数 -link 很重要，它表示你生成的 JavaDoc 中涉及到很多对其他外部 Java 类的引用，是使用全限定名称还是带有超链接的短名称

举个例子，我创建了一个方法 public void func(String arg)，这个方法在生成 JavaDoc 时如果不指定 -link 参数，则 JavaDoc 中对该方法的表述就会自动变为 public void func(java.lang.String arg)，因为 String 这个类对我自己实现的类来讲就是外部引用的类，虽然它是 Java 标准库的类。如果指定了 -link https://docs.oracle.com/javase/8/docs/api/ 参数，则 javadoc.exe 在生成 JavaDoc 时，会使用 String 这样的短名称而非全限定名称 java.lang.String，同时自动为 String 短名称生成一个超链接，指向官方 JavaSE 标准文档 https://docs.oracle.com/javase/8/docs/api/ 中对 String 类的详细文档地址。

-link 实质上是告诉 javadoc.exe 根据提供的外部引用类的 JavaDoc 地址去找一个叫 package-list 的文本文件，在这个文本文件中包含了所有外部引用类的全限定名称，因此生成的新 JavaDoc 不必使用外部引用类的全限定名，只需要使用短名称，同时可以自动创建指向其外部引用 JavaDoc 中的详细文档超链接。

每个 JavaDoc 都会在根目录下有一个 package-list 文件，包括我们自己生成的 JavaDoc。