使用javadoc,导出注释,并生成html文档。 出于懒惰,直接上代码和图。如有疑问可联系我答疑。 程序代码:
/**
* ***车辆管理调用服务
* @Project : vehmgr-api
* @Program Name : com.qdport.vehmgr.service.VehInterfaceYgtService.java
* @Class Name : VehInterfaceService
* @Description : 对外提供的服务接口
* @Author : Maple
* @Creation Date : 2018年1月18日 上午11:32:18
* @ModificationHistory
* Who When What
* -------- ---------- -----------------------------------
* Maple 2018年1月18日
*/
public interface VehInterfaceYgtService {
/**
* <pre>
* 接口描述:车辆信息备案
* 如果是已有的车头车挂,需要传车头车挂id
* </pre>
* @method_Name : insertCarAllInformation
* @creation Date : 2018年4月27日 下午4:49:41
* @author : Maple
* @version : 1.0
* @param headstock 车头实体类,详见附件 {@link Headstock}
* @param trailer 车挂实体类,详见附件 {@link Trailer}
* @param applyAudit 车辆信息申请记录,详见附件 {@link ApplyAudit}
* @return
* <pre>
* {@code Map<String,Object>}
* type:"success","error"
* content:成功或失败的原因
* headstock:车头信息
* trailer:车挂信息
* applyAudit:备案申请信息
* headstockTrailer:车头车挂关系信息
* </pre>
* @exception RuntimeException:保存失败,抛出运行时异常,抛出原因,自动回滚
*/
Map<String, Object> insertCarAllInformation(
Headstock headstock, Trailer trailer, ApplyAudit applyAudit);
}
- 标签 说明
- @author 作者
- @version 版本号
- @param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释
- @return 描述 对函数返回值的注释
- @deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。
- @throws异常类名 构造函数或方法所会抛出的异常。
- @exception 异常类名 同@throws。
- @see 引用 查看相关内容,如类、方法、变量等。
- @since 描述文本 API在什么程序的什么版本后开发支持。
- {@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。
- {@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
- 导出html文档的过程
- 首先,打开MyEclipse工具,右键点击你要导出doc文档的项目
- 接着,点击Export,因为我们需要导出的是javadoc文档,它是在JAVA的目录下的
- 然后,选择Javadoc,点击next,如下图所示:
- 第一栏中显示的是java的jdk编译目录,
- 第二栏中你需要选中你要导出doc文档的项目,
- 第三栏中设置文档的属性,
- 第四栏中设置文档的导出地址。
- 设置完成后,你可以点击next进行一步步操作,也可以直接点击finish结束操作。
如果出现该错误:错误: 编码GBK的不可映射字符 则在最后一步添加一下代码
-encoding UTF-8 -charset UTF-8
将-encoding UTF-8 -charset UTF-8这一段复制到elipse的相应输入框中,如下图: