javadoc使用方法

（1）javadoc命令的描述

javadoc -d （在当前目录下新建的目录）-windowtitle (显示在浏览器上的标题) -doctitle (显示在概览的文档标题) -header （显示在右上角的标题） -version -author *（当前路径下的所有java文件）.java

（2）文档注释的标识符，作用及其使用对象

@author：指定源程序的作者，（可在类、接口前使用）

@version：指定源程序的版本，（可在类、接口前使用）

@since：指定发布时间，（可在类、接口前使用）

@param：方法的参数说明信息，（可在构造器或成员方法前使用）

@return：方法的返回值说明信息，（可在构造器或成员方法前使用）

@exception：用于描述方法签名throws对应的异常（可在构造器或成员方法前使用）

@exception LoginException if the logout fails.

@throws：跟异常类型异常描述 , 用于描述方法内部可能抛出的异常（可在构造器或成员方法前使用）

@throws IllegalArgumentException when the given source contains invalid encoded

@deprecated：不推荐使用的，（可在成员变量前用）（可在所有对象前使用）

@see："参见"，用于指定交叉参考的内容，（可在成员变量前用）（可在所有对象前使用）

@link：用与链接相关的对象，语法：{@link 包名.类名#方法名(参数类型)}，（可用在所有说明文档中）

@code：将文本标记为code，{@code text} （可用在所有说明文档中）

@value {@value} 用于标注在常量上用于表示常量的值 /** 默认数量 {@value} */

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

（3）注意事项

对于有param或return类型的方法需要写，没有形参或返回值是void不需要写。

当一个方法有多个参数时，每个参数占一行，分开写；

如：

@param name, 学生的姓名，String。

@param age, 学生的年龄，int。

@return this.age成员变量，int

（4）写在类前的一般格式

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

第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用。

详细描述一般用一段或多段来详细描述类的作用，详细描述中可以使用html标签，如

、

、、

、 等标签，通常详细描述都以段落p标签开始。

一般每段话都以英文句号作为结束一般段落都用p标签来标记，凡涉及到类名和方法名都用@code标记，凡涉及到组织的，一般用a标签提供出来链接地址。

第三段：文档标注，用于标注作者、创建时间、参阅类等信息

/**

*简要描述

*详细描述（可使用

配合@link, @code等）

*@author 第一作者

*@author 第二作者

*@version V1.0.1

*@since 1999.12

(5)一个实例

package com.example.javadocdemo;

import java.math.BigDecimal;

import java.util.Objects;

/**

* 类 {@code OrderService} 订单服务层.

主要包括创建订单、取消订单、查询订单等功能更

* @see String

* @author Lerry Li

* @since 2019/05/06

public class OrderService {

/** 默认数量 {@value} */

private static final Integer QUANTITY = 1;

/**

* 创建订单.

创建订单需要传用户id和商品列表(商品id和商品数量).

{@code

* 演示如何使用该方法

* List items = new ArrayList<>();

* Goods goods = new Goods(1L, BigDecimal.ONE);

* Goods goods2 = new Goods(2L, BigDecimal.TEN);

* items.add(goods);

* items.add(goods2);

* Order order1 = new Order();

* order.setUserId("1");

* order.setItems(items);

* OrderService#createOrder(order);

* }

* @param order 订单信息

* @throws NullPointerException 参数信息为空

* @exception IllegalArgumentException 数量不合法

* @return 是否创建成功

* @version 1.0

* @see String

public boolean createOrder(String order) throws IllegalArgumentException{

Objects.requireNonNull(order);

List items = order.getItems();

items.forEach(goods -> {

BigDecimal quantity = goods.getQuantity();

if (quantity == null || BigDecimal.ZERO.compareTo(quantity) == 0) {

throw new IllegalArgumentException();

}

});

System.out.println("create order...");

return true;

}

javadoc使用方法相关推荐

【Maven】Maven下载源码和Javadoc的方法
1:Maven命令下载源码和javadocs 当在IDE中使用Maven时如果想要看引用的jar包中类的源码和javadoc需要通过maven命令下载这些源码,然后再进行引入,通过mvn命令能够容易的 ...
使用eclipse生成javadoc的方法
eclipse生成javadoc 1.选择File->Export->Java->javadoc.next. 2.Javadoc comand选择JDK的bin目录下的javadoc ...
接口方法javadoc注释_继承Javadoc方法注释
接口方法javadoc注释尽管用于javadoc工具的JDK工具和实用程序页面通过实现和继承方法来描述Javadoc方法注释重用的规则,但是当实际上不需要使用{@inheritDoc}时,很容易不必 ...
继承Javadoc方法注释
尽管用于javadoc工具的JDK工具和实用程序页面通过实现和继承方法来描述Javadoc方法注释重用的规则,但是当实际上不需要使用{@inheritDoc}时,很容易不必要地显式描述注释继承,因为会 ...
JDK 8 Javadoc调整了方法列表
自开始以来, Javadoc输出基本上是静态HTML,具有导航链接和外观的简单样式表样式. Java SE 7很长时间以来就看到Javadoc输出默认外观的第一个重大变化 ,现在看来JDK 8将在生成 ...
IDEA生成Javadoc报错及处理方法
1.生成JavaDoc的方法 step1:Idea tools菜单下:Generate Javadoc: step2:在弹出的对话框中选择指定的包或文件,也可滤掉指定的包或文件. 如果有自定义的jav ...
java导出javadoc文档
一.注释 (1)文档注释的格式化生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的.比如,需要换行时,不是敲入一个回车符,而是写 ...
JAVA类的无参方法
Java注释: //:单行注释 /**/:多行注释 /** */:JavaDoc注释方法 ...
IDEA方法名,javadoc神器
这两天发现了一个很好用的javadoc 以及方法名称定义的一个插件, 源码作者是在19年开始研发的,到现在21年的最新版本,此处是作者的项目地址: https://gitee.com/starcwan ...

javadoc使用方法

javadoc使用方法相关推荐

最新文章

热门文章