贴一篇我的Javadoc

/**
 * <h1>虚拟礼品卡 soa接口</h1>
 * <pre>
 * <h2>调用说明</h2>
 * <li>引入pom</li>
 *      {@code <dependency>
 *          <groupId>com.jd.bizopen.v</groupId>
 *          <artifactId>jd-bizopen-v-soa-sdk</artifactId>
 *          <version>1.0.6</version>
 *      </dependency>}
 * <li>加入jsf配置</li>
 *      {@code <jsf:consumer id="giftCardService" interface="com.jd.sns.biz.api.service.GiftCardService" 
 *          protocol="jsf" alias="{jsf.version}" timeout="3000" check="false" >}
 *      jsf.version 测试环境test, 生产环境product
 * </pre>
 * 
 * @author cdwangzijian
 * @since 1.0.6
 * @version 1.0.6
 * 
 */
public interface GiftCardService {
    /**
     * <h3>礼品卡下单接口</h3>
     * 
     * @param giftcardOrder {@link GiftcardOrder}
     * @return 
     * <pre>
     *     {@link GiftcardSku}
     *     {@link ResultBase}
     *     {@link SubmitResult}
     * </pre>
     */
    public SubmitResult<GiftcardSku> submit(GiftcardOrder giftcardOrder);

    /**
     * <h3>指定条件分页查询订单</h3>
     * 
     * @param query {@link VirtualOrderQuery}
     * @return 该接口如果内部出现异常时，返回值为null，调用方注意判断空指针。没有查询结果则返回空集合
     * <pre>
     *     {@link Page}
     *     {@link GiftcardVirtualOrder}
     * </pre>
     */
    public Page<GiftcardVirtualOrder> selectGiftcardOrderByPage(VirtualOrderQuery query);
}

一个自带入参表的Javadoc

package com.jd.sns.biz.api.vo;

import java.io.Serializable;
import com.jd.sns.biz.api.enumtype.ErrorCode;
/**
 * <h1>返回结果基础类</h1>
 * 
 * <style type="text/css">
 *      table
 *      {
 *          border-collapse: collapse;
 *          border: none;
 *      }
 *      th
 *      {
 *          border: solid #000 1px;
 *      }
 *      td
 *      {
 *          border: solid #000 1px;
 *      }
 *  </style>
 * <table cellspacing=1>
 * <thead  bgcolor="#a1a1a1" >
 *  <tr>
 *      <th>字段</th>
 *      <th>名称</th>
 *      <th>类型</th>
 *      <th>描述</th>
 *  </tr>
 * </thead>
 * <tbody>
 *  <tr>
 *      <td>success</td>
 *      <td>成功标识</td>
 *      <td>boolean</td>
 *      <td>true:成功， false:失败</td>
 *  </tr>
 *  <tr>
 *      <td>resultMessage</td>
 *      <td>返回信息</td>
 *      <td>String</td>
 *      <td>对应返回码的说明</td>
 *  </tr>
 *  <tr>
 *      <td>resultCode</td>
 *      <td>返回码</td>
 *      <td>String</td>
 *      <td>返回码 {@link ErrorCode}</td>
 *  </tr>
 * </tbody>
 * </table> 
 * 
 * @author cdwangzijian
 * @since 1.0.6
 * @version 1.0.6
 *
 */
public class ResultBase implements Serializable{
    private static final long serialVersionUID = 1L;
    protected boolean success;
    protected String resultMessage = "";
    protected String resultCode;

    public boolean isSuccess() {
        return success;
    }
    public void setSuccess(boolean success) {
        this.success = success;
    }
    public String getResultMessage() {
        return resultMessage;
    }
    public void setResultMessage(String resultMessage) {
        this.resultMessage = resultMessage;
    }
    public String getResultCode() {
        return resultCode;
    }
    public void setResultCode(String resultCode) {
        this.resultCode = resultCode;
    }
}

看下效果：

另外贴一下mvn生成javadoc的命令：mvn javadoc:javadoc