javadoc学习及之间遇到的问题

大学毕业之后，工作有三年了，转行进入java这一行，入职两个星期了。公司内部暂时还没有培训，让自学公司内部软件的使用方式，给时间提升自己。公司的开发软件学完之后，确实有一段时间迷茫期。网上查找了一下，在工作中如何提升自己。我自己得到的答案是第一年把java编程思想认真看完。

因为刚开始看，里面有许多东西是我在做java培训时学过的知识。但是我想要认真把这本书慢慢看完，于是我一字一字地看，碰到陌生的名词就百度，不懂的知识就网上查询学习。今天看到了javadoc的用法。这在培训时，老师并没有跟我讲过。下面就我自己的学习情况，在下面做一些叙述。

我在java编程思想一书中了解到了Javadoc是用于提取注释的工具，它是jdk安装的一部分。
它采用了Java编译器的某些技术，查找程序内的特殊注释标签，它不仅解析由这些标签标记的信息，也将毗邻注释的类名或方法名提取出来，所以可用最少的工作量生成相当好的程序文档。
它输出的是一个HTML文档。这样我们就可以创建。维护单一的源文档，自动生成有用的文档。

但是这其中并没有讲如何用，我看的也是迷迷糊糊，于是我在网上找了个视频，里面提供了两种javadoc的用法。

第一种方法:你自己得找出一个.java文件，里面的文档注释符(/*注释符/)这样的注释符。注释体内以@开头的注释符，具体样式是@see,@version,@author这样的相似的注释符。这样便可以提取到注释符中描写的内容。
有了.java文件之后，如果通过doc命令行方式就是先打开计算机中的cmd窗口。我的窗口打开之后默认在C:\Users\Administrator.SKY-20181107EPS上，为什么到这里呢，因为我在eclipse中找到了.java文件存放的位置，复制了一份直接在c盘目录里，方便进行cmd的操作。在这里值得一提的是，我这里用的并不是eclipse，而是基于eclipse样式的sts软件。具体操作和eclipse一样，只是sts的.java文件，我并不知道自己定义在了哪里。在这里教给大家一个方法。如何在eclipse中准确找到文件/文件夹的位置。首先选中你要查询的文件位置，然后点击File，中文版中也就是文件的目录打开，找到properties，选中之后点击，当即就显示出location的位置。这便是你文件存放的地方。找到.java文件复制到c盘目录下，然后在cmd中输入
javadoc -d help -author -version ArrayTool.java
此操作的意思就是在你.java文件所在的目录下创建一个help文件夹，找到
ArrayTool.java文件中的@author和-version目录提取出来，放到help文件夹中。这便是第一种全部的步骤。之后打开index.html文件浏览器打开，就是你制作的注释网页了。在这其中有一种编码的问题，eclipse中文件书写时，默认是gbk,但是javadoc只能识别utf-8编码的文件。这个问题我在第二种方法中解决了，因为我们用的最多的就是eclipse，在这其中解决更方便我们的操作。下面就开始第二种方法。此种方法更为简单。

第二种方法:首先你选中你的.java文件，然后点击project，出现下拉选项，选中Generate javadoc然后出来了javadoc Generate界面。点击configure，直接出现javadoc的文件所在目录，他是jdk的附带工具，所以在jdk/bin目录下选中javadoc.exe。然后next，再next，在VM option中输入改变编码，不然，你后面运行时一定会出错。-encoding UTF-8 -charset UTF-8，以这样的方式改变编码，中间有空格。然后sava the settings要打勾，才能保存到文件夹中，这里选定保存文件夹的位置。最后finish。如此就生成页面成功了，在文件夹中找到打开页面即可查看。如果不是java类库中自带的备注项，是会出现生成失败的哦！该怎么解决自带定义的备注项呢，下次我再来写吧，这边我也还在学习。