/** * 
虚拟礼品卡 soa接口
 * 
 * 
调用说明
 * 
引入pom
 *      {@code 
      
        *          
       
        com.jd.bizopen.v
        *          
       
        jd-bizopen-v-soa-sdk
        *          
       
        1.0.6
        *      
      } * 
加入jsf配置
 *      {@code 
      
       } *      jsf.version 测试环境test, 生产环境product * 
      
 *  * @author cdwangzijian * @since 1.0.6 * @version 1.0.6 *  */public interface GiftCardService {
         /**     * 
礼品卡下单接口
     *      * @param giftcardOrder {@link GiftcardOrder}     * @return      * 
     *     {@link GiftcardSku}     *     {@link ResultBase}     *     {@link SubmitResult}     * 
     */    public SubmitResult
     
       submit(GiftcardOrder giftcardOrder);    /**     * 
      
指定条件分页查询订单
     *      * @param query {@link VirtualOrderQuery}     * @return 该接口如果内部出现异常时，返回值为null，调用方注意判断空指针。没有查询结果则返回空集合     * 
      
     *     {@link Page}     *     {@link GiftcardVirtualOrder}     * 
     */    public Page
      
        selectGiftcardOrderByPage(VirtualOrderQuery query);}
      
     

一个自带入参表的Javadoc

package com.jd.sns.biz.api.vo;import java.io.Serializable;import com.jd.sns.biz.api.enumtype.ErrorCode;/** * 
返回结果基础类
 *  *  * 
     
       * 
        *  
         *      
 *      
 *      
 *      
 *  
 * 
 * 
        *  
         *      
 *      
 *      
 *      
 *  
 *  
         *      
 *      
 *      
 *      
 *  
 *  
         *      
 *      
 *      
 *      
 *  
 * 
 * 
      
       
        
字段
        
名称
        
类型
        
描述
       
      
      
       
        
success
        
成功标识
        
boolean
        
true:成功， false:失败
       
       
        
resultMessage
        
返回信息
        
String
        
对应返回码的说明
       
       
        
resultCode
        
返回码
        
String
        
返回码 {@link ErrorCode}
       
      
     
  *  * @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