00:00
那么单行和多行说完之后呢,我们接着看第三个叫文档注释,诶关于它的话呢,因为是Java特有的,那我们要说一说什么场景下呢,我们要使用这个文档注释。啊,因为文档出身,我们看似呢,也是里边有多行的,你看啊,也是有多行的,但我们既然有多行出呢,干嘛还引入它呢,哎,它呢有特殊的作用,哎,我们看下边这个。诶,你看我这还写了一段这个一个一个段子啊,哎,这个你看能不能看得懂。嘿,是吧。啊,这个给当成注释了,嘿,我问你问吧。是吧,哎,应该能看懂啊啊,有点冷啊。行,然后呢,我们下边来看这个叫文档注释啊,Java特有的,哎,能做什么用呢?诶把这句话CTRLC。拿过来往这一扔。说文档注释内容可以被JDK提供的工具叫Java dock呢所解析。生成一套以网页文件形式体现了该程序的说明的文档。
01:00
看完以后好像也没什么概念来,我们去演示这儿呢,你是一个多行注释,我在这个位置呢,我写一个。文档主持。哎,你看以两个星这个开头的好,在这里边说呢,这是。哎,我的第一个啊Java程序是吧,啊很嗯开心是吧。哈哈。诶这样是吧,好这呢就写了一句话啊,然后呢,在这里边儿,您可以加入一些补充的信息,比如说这个author。啊,这个叫作者啊,像我我我就习惯用这个来表示我自己了啊,然后呢,来一个叫version啊1.0。啊,这呢,就是这个叫注解的一些信息啊,这个作者是谁,版本号1.0,包括你还可以加上日期,加上你的邮箱,说白了就是你这个代码呢,在整个项目当中可能有。几千个文件啊,其中呢,有几个呢,是你写的,那回头呢,这个文件报错了。是不是直接一看是你写的,直接就找你了。当然也不一定非得出错啊,那回头呢,这个代码呢,要要迭代更新了,诶看原来这个代码是谁写的,互相之间要探讨探讨一看谁写的,这不也很清楚吗。
02:07
哎,这边留你的邮箱,留上你的电话是吧?哎,这样个情况啊,好这呢,我们就可以加上这样一些版本的信息,在这个位置呢,我们也可以加上这个叫文档主持。啊说呢啊,这是没方法。啊,这个格式是固定的。写完了。哎,那这呢叫文档注释,那我顺带着啊,咱们做一个对比,你看我写上一个多行注释。哎,我把这句话呢,CTRLCCTRLV粘过来,这个呢,我写个啊,这个叫多行。就是。这个呢,咱们是文档注释。诶,保存行写完了啊,那写完以后的话呢,我们光看这个代码这个层面似乎你看不出来有什么区别,关键呢,就是我们要使用一个指令呢,去做这个解析了,这个指令呢,是这样来写的啊,这个呢,你就不用死记硬背了,直接你按照这个固定固定格式呢去,呃这个操作一下就行,来回到咱们这个代码层面。
03:09
这块有个小细节注意一下啊,我们此时呢,要想用这个Java dock呢,我们当前的这个class呢,大家把它声明成public。啊,就是保证跟你这个文件名一样啊,在这个情况下,那下边我去执行啊,你照着这个抄就行,诶Java doc是吧,然后杠D。诶后边这个呢,叫my do这个呢,就是我们生成的这个,呃,一系列文件呢,它有一个文件夹,这个文件夹这个名这个你随便起。随便起啊,比如我们写个叫MY叫DR吧,也行啊,然后在空格啊,这个叫author,因为咱们上面不是有这个author信息嘛,我就把这个也保留了啊,然后告诉来一个version。好,再后边呢,就是我们当前这个原文件的名称。在common test Java。哎,就可以了啊,就跟这个格式一样,大家不用死记硬背啊,了解一下你就照着抄下来就行啊,回车。
04:00
完事了。哎,它会生成对应的一个文件夹,就在咱们当前的这个路径下,你看卖DR打开这里边儿有好多的HL格式的这个文件啊,你去找这个叫index,这个就是首页的意思啊,双击打开好,这里边你就会看到一些信息了。那这个信息。这不就是我们刚才自己写的吗?哎,自己写的,注意咱们是放到了文档注释里的,那你上面这个多行注释的信息呢,你会发现这里边儿根本就没有。啊,这个注意,然后包括我们这个酶方法,你看这是没方法。这是没方法,诶小括号里边呢。点开。啊,在这儿是吧,这个格式是固定的括号文档注释啊,那你再回到代码层面。这个是不是就没有啊。哎,所以呢,我们通过Java doc呢,可以去解析出来,咱们文档注释生成一套以网页格式存在的关于当前这个类的一个介绍的信息。
05:00
这就可以了,就相当于你这个类呢,你是干什么用的呀,里边有哪些功能啊,哎,你在这里边可以通过文档注释的方式呢,给它加上,然后生成这样的一套文档,哎,就可以了。OK,这个呢,就是它的一个作用。好,那么文档处这个使用呢,咱们就告一段落了,诶这个说完之后呢,紧跟着咱们再看一看,叫Java API文档。啊,顺带啊,顺着咱们刚才讲的这个文档注释呢,我们往这去说就比较合适一些啊好,那么这里边儿呢,有一个词叫API。以后呢,咱们会经常性的说这个词。啊,其实早上在讲这个内容的时候呢,我我我其实刻意的想避开这个词,然后呢,老是不自觉的想去说,啊这个在哪出现过呢,还有印象不。哎,在这儿啊,这儿呢,是不是出现叫Java SE的API了。哎,就这个啊,哎,这个咱们说的就是Java给我们提供的这个叫现成的是吧。呃,现成的一些类库。哎,我们就可以直接去用了啊,比如说像咱们刚才呢,写的这个程序当中的这个红色的string啊,System这呢,都是现成的一些类啊,这个类里边呢,有一个结构叫alt,我们直接呢,就可以通过点的方式呢,去调用这个现成的这个结构了。
06:15
啊,这呢,就把他们就称为呢叫API。啊,API全称是什么呢?回过来。啊,这个咱们找过来啊。全称呢,叫application programming interface,叫应用程序编程接口。啊,这个呢,就是Java给我们提供的现成的一些基础的一些类。啊,Java呢,现在之所以说很强大是吧?呃热度很高,就是因为呢,呃在整个Java的社区当中呢,呃首先程序员特别多,然后其次呢,这个社区呢,呃热度也很高啊,会有大量的成序员呢,会把自己编写的一些代码呢,发到一些呃开源的平台上,然后呢,其他人呢,都可以拿来去使用,那么发布出去的这些API,这些这个代码呢,其实我们做一个打包,别人也可以去使用,其实呢,你就可以把它就成为了一些类库了,这个类库呢,你可以就理解成就叫做API了。
07:06
啊,所以以后呢,我们说呃,有哪些API可以去调用呢呢,就说诶你有哪些类啊可以去做一些调用啊,就这个意思啊,那咱们现在要讲的叫API文档。也就是说呢,呃,Java呢,提供了非常丰富的API,有没有一个文档说明书让我们看一看,我想用哪个,呃功能是吧,我去哪去找这个功能是哪个类支持呢,这个呢,就有一个文档,就类似于呢大家呃小时候呢,学这个汉字的时候,好多汉字都不认识,那我们有一个新华字典,相当于就是汉字的一个说明书。那现在我们API文档呢,就好比是API的一个说明书啊,就这个意思啊,那么相应的这个API文档,如果你想在线看啊,你点一下这个。啊,这个点开啊,就在这儿啊,这就是在线看了,是JAVA17的啊,如果你要想离线的去下载,你就点这个。那这个你可以点这个就下载了,好,那我给大家发的这个资料里边呢,已经有了。
08:03
找一下。对这个资料这个资料,那这个API文档是吧,好打开以后的话呢,咱们现在用的是JAVA17啊,其实就是这个啊,你把它那挤压以后。啊,比如我做一个解压是吧。诶,它里边呢,是很多的al格式的这个文件。加完以后的话呢,你打开这块,那这有个index点天猫啊,你打开一下,那就跟咱们刚才在线看的这个呢,其实是一样的。啊,那么在这里边呢,你就可以去搜索,比如说啊,咱们刚才提到说这个string呢,它是一个现成的API,我想看看怎么去用,你就在这个位置,你就写这个string。哎,写完以后呢,他这块给我们提示,你想找的是谁呀,跟这个string相关的,哎就在这儿,诶Java点浪包下的一个string,诶点一下这呢,就是关于这个类的一个使用。啊,那关于system呢,你也可以去搜。System。那是不是就找到这个system了,哎,System里边有一个结构呢,叫做out,那这个out呢在哪呢?你往下去找。
09:02
哎,这不是这个吗。那就在这儿了,叫标准的一个输出流啊,以后咱们慢慢再展开说,总之呢,这就是一个文档,方便呢大家进行学习的。啊,当然了,大家发现好像不太方便是吧。这个是不是英文呐。诶确实有这样的问题啊,诶那么我上课的时候呢,我会用17啊,也会用这个英文,然后呢,大家呢,如果说觉得有点困难的话呢,我这块呢,给大家提供了一个版本啊,目前呢,市面上咱们还没有中文版的17的这个API啊呃,比较好的一个呢,是1.6的。啊,这一想哇,这是好久远以前的了是吧?哎,但是呢,1.6翻译的特别好啊,当然网上也有1.8的,但我觉得1.8翻译的有一些准确度不太高啊,1.6呢,咱们在基础阶段,其实学的大部分的API呢,呃,都没有跟六和17呢变化都不大,所以大家你看这个六呢,也没什么影响。
10:00
啊,你在这个六呢,打开以后呢,哎,在这有个显示,在这个位置有个检索索引是吧?诶你去输入一下,刚才我们比如说这个system。那这边这系统点一下双击一下啊就看。看这个那个吧,是吧,好。再说你这点第一个哈,这块呢,就关于这个类的一个介绍,下边呢,你看有这样的一段文字,这个文字跟咱们看的这块呢,基本上是完全对应的啊,你可以对照着一个一个的去匹配都行,那下边呢,关于它里边的这些相关的结构,那都有介绍。咱们学习的大部分的这个API呢,其实你看1.6呢,都是没有问题的。啊,所以大家呢,你可以下来呢,结合着这个六啊和这个17啊,去学习上课的话呢,我会直接就看英文的了。咱们直接就看一手的资料啊,大家以后这个英语呢,随着咱们编程的逐渐深入,英语水平呢,也尽量啊,你也稍微的有意识的去学一学。啊,你不能总指望着说,等有中文的资料以后我再去学习,那你永远都晚别人一步。
11:00
啊,而且呢,有大量的关于技术的相关的一些东西呢,都是英文来写的啊,嗯,不一定都会把它翻译成这个中文。啊,举一个场景,像这个,呃,十多年前的时候啊,那时候安卓呢,刚崛起是吧。当时呢,是北邮的有两个学生,他就把这个谷歌呢,发布的安卓的这套操作系统呢,官方的说明文档给翻译过来了,顺带呢又加了一些案例。然后呢,顺带呢,就出了一本书。啊,然后呢,很多学安卓的人呢,他就一搜书,发现呢,也没有什么别的书可看,就搜到这本书了,然后呢,就买了这本书,后来这本书写的也还行,毕竟是官方文档,改了改也差不到哪去是吧。然后这两个人呢,就成为国内安卓第一人。然后就火了是吧。诶什么意思啊,就是有一些新的技术,包括像咱们大数据,现在也有很多新的一些框架等等哈,诶你要比较早的把一些英文的文章你引到国内,其实你在官网能都能看得到的话,你把它翻译过来,你再写点案例,攒一攒,一本书就出来了,然后这个技术如果真的火了,那你也是第一人是吧。
12:04
啊,就这么简单,没有想象的说那么高大上的啊,他又没说他是最强的,他只说他是第一人而已,是吧?啊,OK啊。好,这个呢,就我们说的这叫API文档,诶大家呢,后边呢,咱们在讲到相关的内容的时候呢,咱们就会看这个文档,我呢就把它集中到这个位置了。啊,直接我点开看就行啊,你在这个位置,你也可以去右键它这个工具栏,去新建工具栏的方式呢,把它添加到这儿啊,就比较方便OK啊。
我来说两句