Java基础-文档注释

Posted on Edited on

​ 我们之前学习过的注释通常就是单行注释和多行注释，比如下面的例子

1
2
3
4
5
6
7
// 这是一个单行注释

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

java中还有一种注释方法名为 文档注释

文档注释的定义 ： 由JDK所提供的一种工具 注释内容可以由javadoc所解析 生成一套以网页文件形式体现的程序说明文档。

其编译的基本形式为

1
javadoc -d 目的文件夹名 -xx -yy 目标java文件

其中 xx yy 为文档注释中的javadoc标签

以下代码块为实例

1
2
3
4
5
6
7
8
9
10
11
/**
	* @author Kmon
	* @version 1.0
*/
public class main()
{
    public static void main(String []args)
    {
        // 这是一段程序
    }
}

我们可以发现 文档注释和多行注释的区别在于 它是以/** 开头 并且标签是由官方规定的 我们不能随便乱取

并且文档注释通常是放在一个类里面

常用的文档标签如下

标签