JAVA学习——Javadoc使用入门

目录

 

一、javadoc定义

二、常用标记

三、代码示例 

---

一、javadoc定义

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

javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

二、常用标记

@author 作者	作者标识
@version 版本号	版本号
@param 参数名 描述	方法的入参名及描述信息，如入参有特别要求，可在此注释。
@return 描述	对函数返回值的注释
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。
@throws异常类名	构造函数或方法所会抛出的异常。
@exception 异常类名	同@throws。
@see 引用	查看相关内容，如类、方法、变量等。
@since 描述文本	API在什么程序的什么版本后开发支持。
{@link包.类#成员 标签}	链接到某个特定的成员对应的文档中。
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。

三、代码示例 

//纯文本作者
@author Rod Johnson

//用于标记当前版本，默认为1.0
@version 1.0

//一般类中支持泛型时会通过@param来解释泛型的类型
@param <E> the type of elements in this list

//跟返回值的描述
 @return {@code true} if the {@code String} is not {@code null}, its

//用于描述方法签名throws对应的异常
@exception IllegalArgumentException if <code>key</code> is null.

//既可以用来类上也可以用在方法上，表示可以参考的类或者方法
@see java.net.URLDecoder#decode(String, String)