2.8注释和嵌入式文档

---

前言

Java8官方在线文档
文档描述对每个系统来说都是必备且重要的，这里将介绍一些javadoc标签，以便加深对文档的理解和编写等。

---

一、注释风格

1.单行注释

单行注释以一个//起头，直到句末，使用方便，案例如下:

This is a one-line comment

2.多行注释

多行注释以一个/*起头，*/结束，案例如下:

/*
* This is a comment
* that continues
* across lines
*/
或者是
/* This is a comment that
continues across lines */

java的注释风格来源于c++

二、语法

所有javadoc命令都只能在/**注释中出现，注释结束于*/,使用javadoc方式有两种:独立文档标签和行内文档标签,此处不再进行区分,行内标签下方标红处理,很容易区分。
共有三种类型的注释文档,分别对应于注释位置后面的三种元素:类、域和方法。
javadoc只能为public和protected成员进行文档注释。private和包内可访问成员的注释会被忽略掉（不过可以用-private进行标记，以便把private的注释包括进去，不过不建议这么做）
文档以html形式生成，所以文档注释中是可以使用html标签来定义样式的。

三、标签

标签	描述	格式
@see	引用其他类,see标签允许用户引用其他类的文档	@see classname @see fully-qualified-classname @see fully-qualified-classname#method-name
@link	该标签与@see标签极其相似,用于行内	{@link Collections#synchronizedMap Collections.synchronizedMap}
@docRoot	该标签产生到文档根目录的相对路径，用于文档树页面的显示超链接	<a href="{@docRoot}/../technotes/guides/collections/index.html">
@inheritDoc	该标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中	{@inheritDoc}
@version	该标签记录版本信息	@version version-information
@author	该标签记录作者信息	@author author-information
@since	该标签允许你指定程序代码最早使用的版本	@since since-information
@param	该标签用于方法文档中	@param parameter-name description
@return	该标签用于方法文档中	@return description
@throws	该标签是由于某个方法调用失败而抛出 的对象	@throws fully-qualified-class-name description
@deprecated	该标签标记一些不被建议使用的旧特性,JDK1.5以后逐渐被@Deprecated 替换	@deprecated deprecated-information

---

总结

回到顶部
官方网站
案例代码 代码是在github上,多刷几次应该就能出来