java中 inheritdoc,【Java】Javadoc的使用

一、名词解释

javadoc是从程序

源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己

API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

简单的来说，就是在Java中写注释，然后形成开发文档。Javadoc用于描述类或者方法的作用，可以写在类上面和方法上面。

二、写在类上

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

使用此文档标记的类或者方法，可用通过按住Ctrl键+单击可以快速跳到相应的类或者方法上，解析成html其实就是使用< code> 包名.类名#方法名(参数类型)< /code>

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

将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。

3. @param

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

4. @author

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

5. @see

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

6. @since 从以下版本开始

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

7. @version 版本

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

三、写在方法上

1. @param

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

2. @return

@return 跟返回值的描述

3. @throws

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

4. @exception

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

5. @see

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

6. @value

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

7. @inheritDoc

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

java中 inheritdoc,【Java】Javadoc的使用相关推荐

java编译程序的基本命令是什么,【填空题】Java中编译java 程序的命令是 1 ,执行java程序的命令是 java 。...
[填空题]Java中编译java 程序的命令是 1 ,执行java程序的命令是 java . 更多相关问题 [多选] 下列骨折中属于关节外骨折的是(). [多选] 骨折早期局部的并发症包括(). [多 ...
java 中lock,java中lock获取锁的四种方法
在java接口中会存放着许多方法,方便线程使用时的直接调用.对于lock接口大家都不陌生,我们已经初步对概念进行了理解.那么在获取锁的方法上想必还不是很清楚.下面我们就lock获取锁的四种方法分别进行 ...
java中setid(),Java Process.setId方法代碼示例
本文整理匯總了Java中org.activiti.bpmn.model.Process.setId方法的典型用法代碼示例.如果您正苦於以下問題:Java Process.setId方法的具體用法?Ja ...
java中.of,java中的sizeof
关键字: java sizeof 在C/C++中,当我们想知道一个对象或者一个原始数据类型所占用的内存大小时,只需简单调用sizeof操作符即可,但是,在java中是没有相应的操作符或者方法来直接完成 ...
java获取vm运行参数_如何获取在Java中运行Java VM的版本？
java获取vm运行参数 To get the version of running VM (Virtual Machine) in Java, we use the getProperties() ...
java中.of,java中instanceof的用法
java 中的instanceof 是一个二元操作符(运算符)运算符,由于是字母组成,所以是Java的保留关键字,它的作用是用来判断,instanceof 左边对象是否为instanceof 右边类的 ...
java中decrement,Java Math decrementExact()用法及代码示例
java.strictmath.lang.decrementExact()是java中的内置函数,该函数返回减1的参数,如果结果溢出指定的数据类型long或int,则抛出异常,具体取决于在方法参数上使 ...
java中文件,java中文件操作大全
java中文件操作大全一.获得控制台用户输入的信息 view plaincopy to clipboardprint? / //获得控制台用户输入的信息 return throws ioexcept ...
Java中的java.util包
The java.util package is part of java.base module. This package contains the most important APIs and ...

java中 inheritdoc,【Java】Javadoc的使用

java中 inheritdoc,【Java】Javadoc的使用相关推荐

最新文章

热门文章