【Java】注释与API
注释
相信很多初学者都没有加注释的习惯吧，是不是觉得给代码加注释很浪费时间？可是，你知道吗？在实际开发过程中，注释占了整个项目很大的一部分比例，大概是30%~60%，那么加注释的作用何在呢？
1、永远不要笑相信自己的理解力，在你编写代码时，你的思路很畅通，感觉没有任何压力，但是几天或者几周以后，你在看自己写的代码时，可能就没有那么顺畅了。
2、增强源代码的可读性。让别人也能看懂你的代码，当别人帮你改代码时，最讨厌写的可读性差的代码了。
讲了这么多，那么Java中有哪些注释的方式呢？
1
单行注释
就是注释一行内容，在需要注释的内容前面用双斜杠（//）
2
多行注释
使用“/*”和“*/”把需要注释的内容包括起来
3
文档注释
一种很强的注释，使用javadoc可以直接把源代码中的注释提取成API文档。文档注释时，使用“/**”开始，最后以“*/”结尾，中间每行的开始都一个*号。
javadoc工具
javadoc工具在生成文档的时候，可以产生很多信息，我们可以利用的javadoc的标记，控制输出的信息。常见的Javadoc的标记：
@author：java程序的作者
@version：源文件的版本
@deprecate：不推荐使用的方法
@param：方法的参数说明
@return：方法的返回值说明
@exception：抛出的异常
@throw：抛出的异常
javadoc工具默认不会提取@author和@version两个标记的信息，需要这两个信息时，需要手动选择，不过建议各位使用高级编译器生成javadoc文档，因为哪个是生成命令实在是...太长了。另外生成文档是要注意编码问题，中文最讨厌的就是编码问题，在编写源代码的时候就要注意自己的编码，改成utf-8，不然生成文档的时候会出现“编码GBK的不可映射字符‘’问题。解决办法：添加命令：-encoding utf-8 -charset utf-8
生成的JPI文档如下图所示，是不是感觉看起来明了多了？
偷偷的告诉你们哦，官方对JDK的源代码也生成了一份API文档，里面包含了Java各种常用的类、函数的注解，有兴趣的可以自己去找一份看看。回复API可以获取可以直接获取中文版JDKAPI一份。
