(Java作业05)Javadoc

什么是Javadoc？

    官方文档：http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html

维基百科：http://en.wikipedia.org/wiki/Javadoc

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的，使用命令行在目标文件所在目录输入javadoc +文件名.java。
你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

Javadoc基本用法

@author： 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可 以使用多次，只有第一次有效

@param、@return 和 @exception ：这三个标记都是只用于方法的

**

Javadoc注释规范

**

一、 Java文档

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

通常这种注释的多行写法如下：

/** 
* ......... 
* ......... 
*/ 

二、文档格式
写在类上的文档标注一般分为三段：

第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束
第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束
第三段：文档标注，用于标注作者，创建时间，参阅类等信息

生成文档是HTML格式。
换行<br>
分段<p>(写在段前）)

eg.
/** 
* This is first line. <br> 
***** This is second line. <br> 
This is third line. 
*/ 

**

如何生成文档

**

1.点击eclipse的【Project】菜单，选择【Generate JavaDoc】选项。
2.Next
（1）选择您要生成JavaDoc的工程

（2）选择哪些级别的内容生成JavaDoc，默认为public，如果选择private则会全部内容都生成。

（3）选择doc的生成位置，默认为工程目录下，建议不要修改。
3.Next
（1）勾选Document Title，然后填写文档标题。

（2）点击【Next】按钮。
4.继续下一步
（1）选择使用的jdk版本。

（2）点击【Finish】按钮。

注意这里加上一个：-encoding UTF-8 -charset UTF-8，可以解决 编码GBK的不可映射字符”问题。（注意一下，这里视情况而定，有的时候不需要添加utf8）
5.可以看到控制台输出生成javadoc的信息

6.项目下生成一个【doc】的目录，里面存放着javadoc文档。

7.打开doc目录，用浏览器打开index.html。

8.最终可以看到一个完整的API文档、javadoc就生成了。

参考：
[1]: https://blog.csdn.net/linton1/article/details/93733508
[2]: https://blog.csdn.net/nuoyuezuo/article/details/84569592