java注释-javadoc规范

写在前面：javadoc内嵌于JDK中，那么遵循javadoc规范自然就是java注释的正统，有javadoc帮忙生成API文档，简直不要太幸福。此文章在逐步完善中，我对于此规范也在学习中，希望能够掌握，也希望文章对你有所帮助。

1.什么是注释

注释是为了使代码更具有可读性，降低团队合作的交流成本。在一个团队中，你的代码更清晰、更易读，更规范，那么升职加薪肯定是你的，因为你可以兼容更多的人。
前段时间听到一个说法：你的代码写的只有你一个人看得懂，那你就是那个不可或缺的人。说这话的人就是脑残，写的代码只有自己看的懂得话，大家都不待见，活的像孙子一样，难道大家都需要孙子吗？

2.常用注释快捷键

• 注释一行：//我是行内容
  快捷键：ctrl+/ 反操作：ctrl+/
• 注释一块：/*我是块内容*/
  快捷键：ctrl+shift+/ 反操作：ctrl+shift+\
• javadoc可识别的注释：

	/**
	 * 我是注释
	 * 我也是注释
	 * 我还是注释，我们都能被javadoc识别
	 */

3.javadoc规范

遵循javadoc规范，我们就可以使用javadoc命令，生成非常直观易读的API文档，非常方便。
我们在程序中出现的注释可以有意识地分为两种，一种是简易的注释，给我们自己看的，一种是符合javadoc规范的注释，目的是生成易读的文档。
仔细阅读生成的API文档，有三部分需要我们说明，如图：