Java Comment Standard:
Function
<P>
Description
<p>
Author
@see
@param
@return
@throws
可以用 html 标签
符号:
符号 #: 表示点 class#method = class.method :: 或代表 this #.method = this.method
tags:
@see 连接到一个具体类中的方法
fullClassName#MethodName(fullClassName)
fullClassName#Member
Class.Method(Type)
@since 来自于
since 和 version 同时出现时, since 在 version 前。表示以前的版本,
@version
版本
@deprecated 不赞成的方法,方法名将会有一个斜线
可在方法注释处添加
在方法名上一行声明,表示该方法 过时
@exception == @throws
{@code content} content将被加粗
{@link class} 链接到实际的类
{@linkplain java.nio.charset.Charset charset} 链接:显示别名 charset 而不是类的全限定名
lables:
<p> 换行
<pre></pre> 段落
<code></code> 标签中的文字将被 加粗 等同于 {@code content}
<a href="Character.html#unicode">Unicode code units</a> 添加连接
<tt></tt> true false 要包含在此标签中
{@inheritDoc} 继承父类的注释