2015-09-22 50 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