Java零基础-063-javadoc的使用原创

好了，那么接下来咱们继续啊，那个咱们这个上午的时候有同学要想看一下这个加油do是吧，加油do这个命令其实它比较繁琐啊，比较比较繁琐，可以也可以看一下啊，也可以看一下来VR test02.java。啊，这个命令呢，有很多参数啊，有很多参数，这个也没必要去记啊，以下的这个内容属于了解内容，不需要掌握，各位啊，别着急啊，Public，然后class va02。然后呢，在这写上public static void方法加上啊。然后这块呢，我们可以用一下这个加了dog注释你看。对吧，哎，加入do注释啊，你可以写上去对吧，这是一个变量测试类二啊，变量测试类二。啊，这是这个类的一个作用对吧，那这样你可以写上作者对吧，作者比如说就写上我自己的名字了。

啊，写上我自己的名字，然后呢，你还可以加上一些比如说版本对吧？啊你你的你这个程序啊，你这个程序写的这个版本，你比如版本，比如1.0版本吧，啊1.0版本，然后呢，你还可以另请参见对吧，你还可以s things自从哪个版本开始，这个类就已经有了，从哪个版本开始这个类就已经有了，比如这个版本号是1.5吧，现在啊，自从这个1.0的时候开始，诶咱们这个类就已经有了。啊，然后呢，这是一个类的一些信息啊，你还可以对这个方法，对这个方法进行一个哎描述对吧？哎进行描述，你比如说你这个方法是吧？啊这是一个啊程序的入口是不是，哎然后呢，你可以给这个方法啊加上一些比如说参数对吧，这个参数呢。啊，参数简单，简单写一写吧，啊简单写一写。然后呢，我们这个程序啊，采用这个加到注释之后呢，你可以给他生成帮助文档啊，可以给这个Java文件生成帮助文档。

啊，你比如说把这个锁定的帮助文档给它生成到哪，生成到这这个位置吧，比如说我们在这呢，啊，去新建一个目录，我们叫Java，嗯，Dot。啊，Java dock啊，或者Java API是不是都行啊，Java doc Java API，也就是说我们这个程序它生成的帮助文档放到Java API这个目录下。啊，给它生成到这个目录里边，我们来看看这个帮助呢是怎样的，好吧，来那么这块呢，我们就可以在这儿呢，看一看DR在这个目录下呢，有一个什么呀，叫做叫VR test02.java对吧，你可以使用加入dock doc这个命令啊，加va dock这个命令就这个命令啊，然后加个杠地参数。杠地。啊，你你指定一下目录，就是说将来这个Java do。生成的帮助文档放到哪个目录下啊，放到这个目录当中，那你就可以写上什么呀，Java API。

什么意思，就是我们呀，可以将这个文件里边那个注释信息提取出来，形成帮助文档，把那个帮助文档放到这个目录下，那你这个时候呢，需要使用Java dock这个命令杠D啊杠D参数我也记不太清有哪些参数啊，简单写一写，如果运行不通过的话，咱们可以再看一看这个相关的一些资料啊，Java dock-d Java API Java API，嗯，然后呢，往后呢，你就可以加上什么呢？加上去你是提取的哪个文件啊，你比如提取的VR是吧，然后TEST02啊点Java，那么也就是说你是希望把CHAPTER03下面的这个VAR test02.java文件，把这个里边的那个注释信息提取出来，生成帮助文档，把那个帮助文档放到这个Java API的这个目录下啊，就这个意思，那么这个帮助文档，呃，这个程序当中啊，它有什么作者呀，有什么版本呀，对吧，你如果是希望把作者信息以及版本信息给它生成进去的话，你可以在这个地方加一些参数啊，加些参。

比如说你可以加上一个作者参数杠对吧，那就表示这个文件里如果有作者信息的话，提取出来，如果有版本信息的话，给它提取出来啊，你就可以简单的这样看一看啊，简单这样看一看，来我敲一下回车，各位啊，我敲下回车看看怎么样啊走。哎，你看。As，哎哟。Para。Name没找到。有一个错误，两个警告。看看它有没有生成啊，生成了是吧，大家看，虽然报错，但是生成了，你看在这个CHAPTER03这个目录下，这个Java API这个目录下生成了对吧？生成这么一大堆，咱们就可以把这个index.html点右键，哎，使用这个浏览器啊，给它打开啊，打开来我们可以看看啊，可以看看这个类，你看叫做VRT02吧，是不是作者是我吧，对不对，版本号是什么呀，是1.5，从以下版本开始，从一个1.0开始就已经有了，对吧？哎，已经有了，然后这里边有个什么方法呀，有一个main方法，你看对吧，Java language string是不是static void，然后这是一个程序的入口，那么这就是一个，呃，这就是一个帮助文档，各位啊，再细致的话，你可以研究的话，研究一下，这个都是次要的啊，这个这就是一个命令对吧，这就是一个命令，你可以直接敲这个命令生成帮助文档，我在这里再强调一下啊，这个不要去研究啊，没必要，没必要，你们现在还没到那个级别啊，到最后我们做项目做了一个完整。

项目之后，如果说你需要生成帮助文档的话，你记住有一个叫做Java do的这样一个命令，这个命令呢，可以帮助你去生成提取帮助文档啊，提取帮助文档，但前提是你的注释啊，得写到这样的符号里边才行啊，你如果是采用这种方式给他注释的，对不起，那您的这个注释信息啊，就提取不到这个帮助文档里边啊，如果你希望哎，你这个注释信息能够提取生成到帮助文档当中，那么你就要使用我们的这种Java注释啊。

来到我这，这是有同学感兴趣，咱们就简单演示一下，看一下好吧，好，这个呢，我就说到这儿。