如何使用maven注释构建jar包

Question

假设我有一个已弃用的方法，并希望用户知道哪个方法与方法签名顶部的注释一起使用。像这样：

/**
 * Deprecated, use OrderService.getOrderListByParams() instead
 * @param merchantId
 * @return orderList
 */
@Deprecated
public List<Map<String, Object>> getOrderList(long merchantId)

例如，用户可以在IDEA中Ctrl+Q查看评论并知道要使用的替代方法。

如何在pom.xml中具体说明并使maven与代码一起构建方法信息？

Answer 1

通常在构建.jar文件时，它只包含编译的java字节代码，而不包含源代码或javadoc。

听起来您想要在.jar文件中包含来源。您可以使用maven source plugin执行此操作。