2015-09-22 14 views
0

比方说,我有一个方法已被弃用,并希望用户知道哪个方法使用方法签名顶部的评论。就像这样:如何构建jar包与maven的评论

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

再举例来说,用户可以在Ctrl+Q IDEA看注释,知道哪些取代的方法来使用。

我该如何具体说明pom.xml并使maven与代码一起构建方法信息?

+0

'mvn site'用于文档。 –

+0

@SubodhJoshi你的意思是我应该与maven单独的文档,并将其传递给maven服务器一些如何? – armnotstrong

+1

“标准”jar包含编译代码(没有评论),你可能想要创建一个javadoc jar(有一个[插件](https://maven.apache.org/plugins/maven-javadoc-plugin/) ) –

回答

0

通常,当您构建.jar文件时,它只包含合适的java字节码,并且不包含源或javadoc。

听起来像你想包括在.jar文件中的来源。你可以使用maven source plugin