Javadoc了解

Wesley13
• 阅读 745

引用百度百科的说法:javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

使用方法:使用命令行在目标文件所在目录输入javadoc +文件名.java。

//参考博客:https://blog.csdn.net/vbirdbest/article/details/80296136

Javadoc注释规范:

//  注释单行

/ *           */ 注释若干行

/**   ……*/ 注释若干行,写入Javadoc文档

Ⅰ.写在类上的Javadoc

① 第一段:概要描述,通常用一句或者一段话简要描述该类的作用,以英文句号作为结束

示例1(单行):

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 */

public abstract class StringUtils {

示例2(多行):

/**
 * Class {@code Object} is the root of the class hierarchy.
 * Every class has {@code Object} as a superclass. All objects,
 * including arrays, implement the methods of this class.
 */

② 第二段:详细描述,通常用一段或者多段话来详细描述该类的作用,一般每段话都以英文句号作为结束

示例:

package org.springframework.util;

/**
 * Miscellaneous {@link String} utility methods.
 *
 * <p>Mainly for internal use within the framework; consider
 * <a href="https://my.oschina.net//u/4411838/blog/4175340/span>http://commons.apache.org/proper/commons-lang/">Apache's Commons Lang</a>
 * for a more comprehensive suite of {@code String} utilities.
 *
 * <p>This class delivers some simple functionality that should really be
 * provided by the core Java {@link String} and {@link StringBuilder}
 * classes. It also provides easy-to-use methods to convert between
 * delimited strings, such as CSV strings, and collections and arrays.
 *
 */

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

注:详细描述一般用一段或者几个锻炼来详细描述类的作用,详细描述中可以使用html标签,如<p>、<pre>、<a>、<ul>、<i>等标签。

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

详细描述和概要描述中间通常有一个空行来分割

Ⅱ:Javadoc标签

标签

说明

@author 作者

作者标识

@version 版本号

版本号

@param 参数名 描述

方法的入参名及描述信息,如入参有特别要求,可在此注释。

@return 描述

对函数返回值的注释

@deprecated 过期文本

标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。

@throws异常类名

构造函数或方法所会抛出的异常。

@exception 异常类名

同@throws。

@see 引用

查看相关内容,如类、方法、变量等。

@since 描述文本

API在什么程序的什么版本后开发支持。

{@link包.类#成员 标签}

链接到某个特定的成员对应的文档中。

{@value}

当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。

点赞
收藏
评论区
推荐文章
Wesley13 Wesley13
3年前
java 多进程
多进程的概念一个JVM进程对应一个JAVA程序Java编写程序都运行在在Java虚拟机(JVM)中,在JVM的内部,程序的多任务是通过线程来实现的每用java命令启动一个java应用程序,就会启动一个JVM进程。在同一个JVM进程中,有且只有一个进程,就是它自己。
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Wesley13 Wesley13
3年前
java SerialPort串口通讯的使用
api文档http://fazecast.github.io/jSerialComm/javadoc/com/fazecast/jSerialComm/packagesummary.html(https://www.oschina.net/action/GoToLink?urlhttp%3A%2F%2Ffazecast.github.
用命令行写一个Java的"Hello World"
1、新建一个文本文档2、在该文档内写出代码publicclassHelloWorldpublicstaticvoidmain(String5、然后使用javac命令编译程序,输入以下代码:javacencodingUTF8HelloWorld.java(此时先不要关闭cmd)成功之后会在HelloWorld.java所在的目录下生成同名
Wesley13 Wesley13
3年前
javaDoc
我们知道Java中有三种注释语句:1.//用于单行注释。2./\...\/用于多行注释,从/\开始,到\/结束,不能嵌套。3./\\...\/则是为支持jdk工具javadoc.exe而特有的注释语句。   javadoc工具能从java源文件中读取第三种注释,并能识别注释中用@标识的一些特殊变量(见表),制作成Htm
Wesley13 Wesley13
3年前
Java中为什么需要Object类,Object类为什么是所有类的父类
Java中Object是所有类的父类,所有类的对象都是Class类的实例。贴上javadoc中的说明!(https://static.oschina.net/uploads/space/2017/0320/224831_Uobg_1400660.png)为什么我们需要Object类这个问题找到了一个外国哥们的回答,
Wesley13 Wesley13
3年前
Java入门——编写并运行第一个程序
Java入门——编写并运行第一个程序摘要:本文主要介绍如何使用Java语言编写并通过DOS运行简单的程序。编写简单的程序在D盘新建一个文本文档,输入如下代码:1classHello{2publicstaticvoidmain(Stringarg
Wesley13 Wesley13
3年前
Java 读写锁 ReentrantReadWriteLock 源码分析
本文内容:读写锁ReentrantReadWriteLock的源码分析,基于Java7/Java8。阅读建议:虽然我这里会介绍一些AQS的知识,不过如果你完全不了解AQS,看本文就有点吃力了。目录使用示例下面这个例子非常实用,我是javadoc的搬运工://这是一个关于缓存操作的故事classCach
Wesley13 Wesley13
3年前
JavaSE 基础大纲
Java基础(JavaSE)1、Java基础语法;1、1注释行内注释//多行注释/\\/文档注释/\\\/javadoc生成帮助文档1、2标识符关键字1、3数据类型1、基本数
Wesley13 Wesley13
3年前
Java语言基础
一,注释1,分类单行,多行,文档注释2,文档注释a,生成APIb,用法:javadoc 注:ApplicationProgrammingInterfaces应用程序编程接口(其实就是说明书)3,注释是不会出现字节码文件里的二,包1,简述a,包是用来管理类的,类似文件夹管理文件b,其作用为防止命