JavaDoc


javadoc命令是用来生成自己API文档的


参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况



通过命令行生成javadoc文档
#javadoc 参数 java文件
javadoc -encoding UTF-8 -charset UTF-8 Doc.java



通过IDEA生成javadoc文档


Tools(工具)→Generate JavaDoc(生成JavaDoc)→进行配置


配置页面的参数说明:
1.Whole  project:整个项目都生成文档
2.Custom  scope  自定义范围。如下：
（1）project files  项目文件，
（2）project production files  项目产品文件，
（3）project test files  项目的测试文件，  未知范围，class  hierarchy  类层
3.include  test source  包含测试目录
4.include  JDK and  …  包含jdk和其他的第三方jar
5.link  to  JDK documentation…链接到JDK api
6.output  directy  生成的文档存放的位置
（1）private、package、protected、public  生成文档的级别（类和方法）
（2）右边的Generate…是选择生成的文档包含的内容，层级树、导航、索引…
（3）再右边是生成的文档包含的内容信息，作者版本等信息
7.Locale  语言类型,zh-CN
8.Other  command line arguments  其他参数
9.Maximum  heep…  最大堆栈

下午看了与javadoc相关的一点东西，还没看完，先把链接码在这里。
Javadoc在Eclipse中的配置和使用
Eclipse中javadoc文档的使用说明
javadoc 和 javadoc注释规范
Javadoc 使用详解

Javadoc
一、什么是Javadoc

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

二、Javadoc的常用标记




标签
说明




@author 作者
作者标识


@version 版本号
版本号


@param 参数名 描述
方法的入参名及描述信息，如入参有特别要求，可在此注释。


@return 描述
对函数返回值的注释


@deprecated 过期文本
标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。


@throws异常类名
构造函数或方法所会抛出的异常。


@exception 异常类名
同@throws。


@see 引用
查看相关内容，如类、方法、变量等。


@since 描述文本
API在什么程序的什么版本后开发支持。


{@link包.类#成员 标签}
链接到某个特定的成员对应的文档中


{@value}
当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。


三、Javadoc的命名格式
Javadoc命令格式：javadoc [选项] [软件包名称] [源文件]
四、Javadoc的基本使用
1.类上的Javadoc
写在类上面的文档标注一般分为三段：
第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束。

第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束。

第三段：文档标注，用于标注作者，创建时间，参阅类等信息。
2.方法上的Javadoc
写在方法上的文档标注一般分为三段：
第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束。

第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束。

第三段：文档标注，用于标注参数、返回值、异常、参阅等。

1.什么是javadoc？

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

一、 Java文档
// 注释一行

/ *    / 注释若干行

/*   ……*/  注释若干行，写入Javadoc文档
二、文档格式

写在类上的文档标注一般分为三段：
第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束

第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束

第三段：文档标注，用于标注作者，创建时间，参阅类等信息