java注释

//注释一行
/*.....*/注释若干行
/**.....*/注释若干行，并写入javadoc文档

javadoc标记

javadoc中可以插入html标签

通用注释

注释内使用

方法注释

导出javadoc

eclipse，在项目列表中按右键，选择Export(导出) -> java -> javadoc
点击Next>(下一步)，在javadoc command中选择javadoc.exe程序的路径（jdk目录下的bin\javadoc.exe）;
再Use standard doclet中选择javadoc的生成路径。点击Finish(完成)。

例子

package com.lwg;

/**
 * 
 * @author Luoweigaung
 * @version 1.0.1
 * @since JDK1.7
 */
public class Vehicles
{
    /**
     * 速度
     */
    public float speed;

    /**
     * 
     * @return speed {@link #speed}
     * @see #setSpeed()
     */
    public float getSpeed()
    {
        return speed;
    }

    /**
     * 
     * @param speed {@linkplain #speed 速度}
     * @see #getSpeed()
     */
    public void setSpeed(float speed)
    {
        this.speed = speed;
    }
}

package com.lwg.bean;

import java.io.IOException;

import com.lwg.Vehicles;

/**
 * <p>Car简介</p>
 * {@code Car}继承至{@link Vehicles},请参考{@linkplain Bicycle 自行车}与{@linkplain Bus 巴士}等
 * 
 * 
 * @author Luoweiguang
 * @version 1.0.1
 * @see Vehicles
 * @since JDK1.7
 * 
 */
public class Car extends Vehicles
{

    /**
     * 花费
     */
    public int money;

    /**
     * 该方法用于获取价格
     * @throws IOException <p>如果money为0,则报异常</p>
     * @return {@link #money}
     * @see #setMoney(int)
     * @throws 
     */
    public int getMoney() throws IOException
    {
        if(money == 0)
        {
            throw new IOException();
        }
        return money;
    }


    /**
     * 该方法用于修改价格
     * @deprecated <p>使用此方法可能使数据异常</p>
     * @param {@link #money}
     * @see #getMoney()
     * @see <a href="www.baidu.com">百度</a>
     */
    public void setMoney(int money)
    {
        this.money = money;
    }


    //入口方法
    public static void main(String[] args)
    {
        System.out.println("Hello World");
    }


}