JavaDoc学习

JavaDoc简介

JavaDoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

JavaDoc的意义

我们知道注释是为了解释代码的作用的，是为了将来给自己或者别人快速了解代码的，在方法内一般用//的比较多，是针对一小块代码做出解释的，而JavaDoc的作用是针对整个方法或者整个类做一个简要的概述的，使得别人不通过看具体方法代码就能知道某个方法或者某个类的作用和功能。写了JavaDoc的在别人使用到类时，将鼠标悬停到类上或者方法上，JavaDoc会以提示信息显示出来，这样开发者在跳进源代码中就能知道类或者方法的作用，极大的节约了理解代码的时间。

Javadoc标签

Javadoc的生成

对于一份已经写好详细注释的java工程代码，我们在当前工程名上鼠标右击，会出现下拉选项栏，选择 “Export…”

接下来在 “Export” 配置页面，选择 “Java -> Javadoc” 选项，然后点击 “Next”