Javadoc-API开发文档生成

摘要：通过Java doc工具为项目程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档。介绍Eclipse及Android Studio中生成项目API开发文档，帮助学习上手项目。

Java Doc

概述

百度百科：javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的，使用方式：在dos中在目标文件所在目录输入javadoc +文件名.java。

常用标记

详情可查看javadoc：Javadoc Tool Home Page

注释规范

注释

// 注释一行
/* …… */ 注释若干行
/* …… / 注释若干行，并写入 javadoc 文档

注释格式

可嵌入HTML标签
回车：< br >
分段： < p >

例如：
/**
* show 方法的简述.
*

show 方法的详细说明第一行

* show 方法的详细说明第二行
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。
* show 方法的简述.
* < p >show 方法的详细说明第一行< br >
* show 方法的详细说明第二行

简述也在其中。这一点要记住了

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值

Eclipse

1. Project——>Generate Javadoc

   

2. 选择项目

   

3. 设置文档名称等

   

4. 设置编译选项

   

Android Studio

1. Tools——>Generate JavaDoc…

   

2. 选择输出的范围等

   

参考

javadoc注释规范
javase documentation