这是我参与更文挑战的第3天，活动详情查看： 更文挑战
编写程序一定要写的不仅仅是高效的代码，注释也是不可忽略的。
**一篇合格的源代码里至少包括1/3的注释！**
为什么注释如此重要呢？
那我们首先要知道注释是用来干什么的。注释用来说明代码的用途，可以说明类的功能，方法的作用，变量的作用等等。
那为什么一定要写注释呢？因为当你思路通畅的时候，往往写代码很顺利，但当你过一段时间后再来看自己曾经写过的代码时，你会发现？这是我写的代码？？？人的大脑是有限的，有极大地可能你已经看不懂当初自己写的代码了，毫无疑问这是一件非常痛苦的事，因此我们刚开始就要养成写注释的好习惯。
java三种文档注释方式
- 单行注释 2.多行注释 3.文档注释
单行注释和多行注释
单行注释就是在这一行的开头加上(//)
多行注释就是在需要注释的开头加上（/*）,在结尾加上（*/）
例如：
public class Hello {
/*这里是多行注释
欢迎来到java世界！
*/
public static void main(String[] args){
//System.out.println("这就是单行注释");
}
}
文档注释
java语言还提供了文档注释，它具有更加强大的功能！！！ 它通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成为一份系统的API文档，可以通过网页打开。
说到API这应该是每个程序员所必须会的技能，javaAPI包含了java各种类和方法的介绍使用，学会查看API对于我们学习java有很大帮助，java中的类非常多，我们不可能都记得住，当我们不确定或者忘记某些类的作用时，我们就可以打开API文档来查询类和类中包含方法的具体使用。
回到正题，文档注释格式是怎么样的呢? 文档注释以（/**）开始，以（*/）结束，中间都是文档注释的内容
public class Hello {
/**
* 这里是文档注释，是不是很简单呢？
* @param args
*/
/*这里是多行注释
欢迎来到java世界！
*/
public static void main(String[] args){
//System.out.println("这就是单行注释");
}
}
那么如何生成API文档呢？
需要使用javadoc命令，基本语法格式如下。 javadoc 参数 java源文件/包 javadoc常用的参数有：
-d 文件夹；//用于指定目录放置生成的API文件
-windowtitle 标题；//用于指定一个标题，作为API文档浏览窗口的标题
-doctitle 标题；//用于指定浏览器页面的标题
-header 页眉；//用于指定每个页面的页眉
下图是我生成的一个API文档，大家也赶快去试试吧！
以上内容如有不对，欢迎大家指正。欢迎大家评论探讨！
