目录

  • 一、前言
  • 二、格式
  • 1、单行注释
  • 2、多行注释
  • 三、类注释
  • 四、注释标记
  • 1、类文档标记
  • 1、@version
  • 2、@author
  • 2、方法文档标记
  • 1、@param
  • 2、@return
  • 3、@exception
  • 4、@deprecated
  • 三、总结


一、前言

  Java 里有两种类型的注释。第一种是传统的、C 语言风格的注释，是从 C++继承而来的。第二种类型的注释也起源于C++，第三种后续揭露，下面介绍一下如何使用吧。

二、格式

1、单行注释

  最常用的方式是使用//，其注释内容从//开始到本行结尾。以一个“//”起头，表示这一行的所有内容都是注释。举个例子。

//单行注释

2、多行注释

  （1）第一种多行注释
  “/”起头，随后是注释内容，并可跨越多行，最后用一个“/”结束。将一段比较长的注释括起来。

/*
     这是多行注释
     这是多行注释
     这是多行注释
     */

  （2）第二种多行注释
  下面多行注释注释可以用来自动地生成文档。这种注释以/*开始，以/结束

/**
     * 这是多行注释
     * 这是多行注释
     * 这是多行注释
     * 这是多行注释
     */

三、类注释

  类注释必须放在import语句之后，类定义之前，如下。

import java.util.ArrayList;

/**
 * test1
 *
 * @author jiankang.xu
 * @date 2022/4/11
 */
public class test1 {

  这是idea自动生成的，后期会介绍一下idea如何配置自动生成注释。

四、注释标记

1、类文档标记

1、@version

  格式如下：其中，“版本信息”代表任何适合作为版本说明的资料。

@version 版本信息

2、@author

   格式如下,其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。

@author 作者信息

2、方法文档标记

1、@param

   格式如下：其中，“参数名”是指参数列表内的标识符，而“说明”代表对参数的介绍。

@param 参数名 说明

2、@return

  格式如下：其中，“说明”是指返回值的含义。

@return 说明

3、@exception

  格式如下：其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”告诉我们为什么这种特殊类型的违例会在方法调用中出现。

@exception 完整类名 说明

4、@deprecated

  该标记的作用是建议用户不再使用，因为未来改版时可能废弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。