java文档注释


Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。


这里主要讲述，最后一种方法注释，因为可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

注释方式主要有以下三种

行首注释关键字

关键字	描述
@see	引用其他类
@version	版本号
@author	作者
@since	从什么时候开始，与版本号对应
@param	参数
@return	返回值
@throws	抛出异常
@deprecated	过时
@category	种类

@see

/**
 * @see CallBack
 */

点击

@version、@author、@since

/**
 * @version 1.0
 * @author 张三
 * @since 1.0
 */

@param

@return

@throws

    /**
     * 
     * @param x 输入参数1
     * @param y 输入参数2
     * @throws Exception  
     *     
     * @return  返回值为float类型
     */

@deprecated

/**
 * 
 * @deprecated
 */

@category

行内注释关键字

关键字	描述
{@link}	引用其他类，与see功能相似，是行内用法
{@linkplain}	与{@link}，显示格式不同
{@inheritDoc}	继承父类中注释
{@docRoot}	暂时不清楚
{@value}	static final常量显示
{@code}	代码格式

{@link}、{@linkplain}

其中

/**
 * 采用栈模拟递归，具体实现了方法
 *  <p>{@link #next()}  与
 *  <p>{@linkplain #hasNext()}
 * 
 *  <p> <b>ps:其中linkplain字体更大一些
 */
public class CompositeIterator implements Iterator<Component>

点击Iterator

{@inheritDoc}

父类注释

/**
 * 抽象模板方法定义的抽象方法{@linkplain #privimitiveOperation1()}，具体模板参考{@linkplain #templateMethod()}
 */

子类注释

    /**
     * {@inheritDoc}
     * 
     * <p>子类<b>ConcreteClass</b>实现具体抽象方法，这里简单打印一句话</p>
     */

{@value}

    /**
     * 地点默认值：{@value}
     */
    public final static String MGMT_DISTRICT = "北京";

{@code}

/**
 * <p>适配器，将Component类型适配为Iterator<Component>类型<p>
 * 
 * 例如：
 * <pre> {@code Component menu = simpleFactory();
 * Iterator<Component> it = new IteratorAdapter(menu);
 * } </pre>
 * 
 */

常用HTML注释关键字

关键字	描述
<a>	超链接
<b>	粗体
<blockquote>	引用
<br>	换行
<code>	代码风格
<dl>	定义列表
<dt>	主题
<dd>	内容
<em>	强调的内容
<h1> -<h6>	标题
<hr>	水平线
<i>	斜体
<ul>	无序
<ol>	有序
<li>	列表元素
<p>	段落
<pre>	保持原有格式
<q>	用于简短的行内引用
<strong>	更强的强调的内容。
<td>	元素
<th>	标题行
<tr>	元素行

html都是辅助元素，用于修饰作用，具体参考html定义即可，使用什么根据个人习惯