day01_Java语言概述/21-尚硅谷-Java语言基础-文档注释的使用

好，那接着单行注释，多方注释完了以后，我们说第三个叫文档注释，这个文档注释呢，是我们Java所特有的啊，那也就意味着呢，在其他的编程语言当中呢，其实它也有一些注释的方式啊啊，比如像HM当中啊，这个这个GS当中啊，叉L当中啊等等，它也有相应的一些注释的方式，只不过呢，可能跟我们这个章啊不一样啊而已，比如像有的这个语言当中的注释方式，它是这样的啊，他用一个这个这个监括号是吧，一个叹号啊杠杠，然后呢，这有个杠杠，一个监号收起来，然后在中间呢，写这个注释信息啊，这个你有点像单行，但是你要这样换一下行，这就像多行的了，就不同的语言的这个注释方式呢，可能不太一样，但是呢，基本都会有这个单行和多行的啊，但是这个文档注释呢，不是说所有语言都有了，那咱们看下这个Java中文档注释它是做什么用的啊，先来看下我们PPT。

啊，这个一会看啊，看这文档注释它的格式呢，是长这个样子的啊，一个斜杠两个型啊。哎，然后再一个斜杠，呃，一个形一个斜杠上结束，这呢叫做文档注释。哎，文档注释好像这里边也可以写多行哈，还有一些其他的一些信息，就像这样的，好像跟我们这个多行看着好像没啥区别是吧，不得都是不也都是注释吗？那区别在哪呢？下边写到了说我们文档注释，它注释的内容呢，是可以被我们JDK提供的一个工具叫做Java doc所解析的，解析以后呢，它会生成一套以网页型文件啊形式存在的该程序的说明文档。啊，看不太明白是吧，我们CTRLC先拿过来我们演示啊，这是我们说的第四个问题。哎，文档注释的使用，哎，首先呢，大家先关注一下它的一个格式啊，然后呢，我们关注它的一个特点，哎，这就是他的一个特点。

啊，它呢，注释的内容可以被Java do所解析来，那咱们呢，给大家演示一下啊，比如说咱们刚开始这个类的上面呢，这其实写了一个大的一个多行注释哈，咱们并列的呢，在这块写一个它。两个星，一个星，一个斜杠结束，中间呢，这就是文档注释。啊，这是文档注释，那这里边呢，我们可以写一些信息啊，比如说像这个咱先来一个叫author啊，啊这个作者，那通常呢，我都爱用这个符号表示我自己了啊，然后再来一个比如version版本号啊1.0的版本说呢，哎，这是我的第一个Java程序啊，非常的开心，开心是吧？啊对，哎，这就写完了啊这呢写的这是一个文档注释啊，然后呢，这个是一个多行注释，那我这我我也想补一个啊，比如我在这再补一个啊一个斜杠两个星啊一个星一个斜杠啊这又是文档注释啊，在这个位置我们说说如下的方法啊是。

嗯，是这个没方法，哎，它的作用啊，就是程序的一个入口，诶写完了。啊，写完了，这是一个文档注释，这是一个多行注释啊，那我就写成这样写两个啊，那这个写的特点呢，他说是可以被Java do所解析的，那怎么去解析，下边咱们来演示。啊，下边来演示，那演示的时候呢，其实有一个呃小的细节点啊，我们先把这个事儿先补充上，一会呢去解释说明，就是呃，Java到和解析的这个类的话呢，我们通常呢，都会给它加上一个public，就跟这个public一样啊这呢我也补上这个public，补上以后CTRLS这个我有时候就不点它了啊，我就键盘CTRLS了，接着我们呢，在这个命令行咱们去编译，呃，不是编译了，咱们用Java dock去解析这个刚才写好的这个文件啊嗯，怎么去用Java do解析呢？下边有一个案例。

在这写着呢，哈扎，Do。杠D啊，起一个文件夹的名字，杠杠version，哎，写我们整个文件名字好。哎，在我们对定一下Java dock-D起一个名字哈，比如说我们叫my hello吧，哎，然后在后面啊写什么呀，杠杠version。诶，然后呢，来写我们这个文件名字，咱们叫hello Java。

第二扎是吧，这就OK了啊，然后回车。啊，这时候你看它生成一系列的这样一个操作过程啊，哎，完成以后呢，这就生成了一个my hello，也就是我们这里的这个文件名，文件夹的名字。把这个文件夹的名字文件夹上打开，这里边呢有很多的HTML格式的文件，其中有一个呢，叫做首页啊index啊，双击打开。诶，这就打开了，打开以后这不是咱们写了一个类，不是叫哈Java吗。这就能看得到啊，然后大家看这块儿，你看这块呢，有一些文字啊，这个文字呢，是不是就咱们刚才自己写的呀。说文档注释版本号，这是我的第一个账号程序，非常的开森啊，哎，作者。哎，然后呢，这不就是我们刚才里边写的这些内容。但你会发现，诶上面这些呢。上面这么多是不是没有在我们这里体现呀？啊，那也就是说我们Java dock它是不是只能够去提取咱们这个文档出示这个不行是吧？哎，这就是他们的区别啊，就是单行多行是不可以被Java do所解析的啊，那同样的关于这个main方法，哎，我们这写了一个文档的，只写了一个多行的，你肯定呢，这个有这个就没有了，往下看。

这哎如下是没方法，然后作用程序入口，哎，这不就咱们写的这个话吗。哎哎，也就说明了，就是我们这个文档注是到底做什么用处的啊，就是咱们呢，呃，回头写代码写的特别多的时候，咱们可以用Java do1解析，这个时候呢，就会把一个一个的你写好功能呢都列出来，然后你通过文档注释的方式，诶告诉这个别人看的时候说，诶你这个方法是做什么用的啊可以这样子呢，就啊行这呢就是咱们说的这个文档主旨的一个作用的演示啊后续呢，咱们写程序呢，呃，到时候讲项目的时候呢，诶咱们就都会用上了，到时候大家关注一下我是怎么用的，你就也照着这个方式去用就可以啊。