文档注释

自从面试了阿里之后，发现基础真的很重要，以前觉得很多基础不用记，知道个大概，用到的时候查一下就好了，但是有谁在计算“1+1=？”的时候会说：等等，我百度一下~所以立志从基础走起，打牢基础，才能以不变应万变。

最近在看疯狂的java讲义，看到注释一节，发现了一个新的知识点——文档注释（原谅我之前只知道单行注释和多行注释的粗鄙浅薄^_^!）。所以我在这里简单的总结一下文档注释的作用和用法

一、什么是注释

java编程过程中需要对一些程序进行注释，除了方便自己阅读，更为别人更好的理解自己的程序，所以我们需要进行一些注释，可以是编程思路或者程序作用等，总而言之，注释就是为了方便自己和他人更好的阅读。

二、注释作用

1.通过注释提高java源程序代码的可读性

2.使java程序条理清晰，易于区分代码行与注释行

3.等

三、文档注释

格式：javadoc 选项 java源文件/包

注意：关于选项中包含什么，以及其他的一些语法，我不过多描述，可以通过javadoc -help查看

还是直接通过一个实例进行说明吧：

实例（命令行中进入源文件所在路径）：

注：-d apidoc 指定api文档存放的文件夹，默认是当前路径下的apidoc文件夹下

-encoding utf-8 :编码格式utf-8

-windowtitle 学习：指定index.html文档的title

-doctitle 学习javadoc工具的测试API文档 ：指定文档的标题

TeacherTest.java：java源文件

运行结果：

你可以在apidoc文件夹下看到如下的文件和文件夹：

用浏览器打来index.html，你就可以看到自己的API了：