java 生成doc 注意事项

在写注释的时候

 

    /**
     * 风险方案查询.
     * <p>
     * 服务ID：fxpt.core.fak.fxfa.service.query
     * <p>
     * 服务名称：风险方案查询
     * <p>
     * 业务实例：可支持风险方案查询
     * 
     * @param fabh
     *            方案编号
     * @return fxfa 方案实体
     * @throws FkptServiceException
     *             服务类异常
     */
    public Fxfa query(String fabh) throws FkptServiceException;

 风险方案查询.

这个红色的句号就是为截断文本的

如果不加句号 那么方法摘要里会显示所有的文字

方法摘要

cn.com.servyou.fkpt.core.fak.bean.Fxfa	query(java.lang.String fabh)            风险方案查询 服务ID：fxpt.core.fak.fxfa.service.query 服务名称：风险方案查询 业务实例：可支持风险方案查询

加了句号的效果如下

方法摘要

cn.com.servyou.fkpt.core.fak.bean.Fxfa	query(java.lang.String fabh)            风险方案查询.

query

cn.com.servyou.fkpt.core.fak.bean.Fxfa query(java.lang.String fabh)
                                             throws cn.com.servyou.fkpt.core.exception.FkptServiceException

风险方案查询.

服务ID：fxpt.core.fak.fxfa.service.query

服务名称：风险方案查询

业务实例：可支持风险方案查询

 

参数：

fabh - 方案编号

返回：

fxfa 方案实体

抛出：

cn.com.servyou.fkpt.core.exception.FkptServiceException - 服务类异常