我有一個 Gradle Spring Boot API 專案和另一個 Maven 專案,我將它們作為 Artifact 構建到 .jar 檔案中,并作為模塊匯入到我的 API 專案中。這樣做之后,一切正常,但是當我查看 API 專案中的方法時,我在 Maven 專案中為所有服務和方法所做的 Javadoc 注釋沒有被保留。有沒有辦法將 Javadoc 注釋帶到 API 專案中?
uj5u.com熱心網友回復:
經過一番研究,我想出了一種方法來做到這一點。把它貼在這里,以防萬一其他人需要幫助。首先,您需要在專案中添加一個 Javadoc 插件(這將為 javadoc 創建一個 .jar 檔案),該插件應該打包成一個 .jar 檔案以匯入到另一個專案中。
在需要匯入 *.jar 檔案的專案中:轉到檔案 -> 專案結構 -> 模塊(在側面導航欄中) -> 依賴項 -> 找到您已匯入的 .jar 要將 Javadoc 附加到-> 右鍵單擊??然后“編輯”
打開一個新視窗,如果您的 Javadoc 是 *.jar 檔案,請單擊“ ”按鈕,然后找到該 *.jar 將其添加到那里。如果是鏈接,則添加鏈接符號并插入鏈接。
這應該在模塊 *.jar 檔案和它的 Javadoc *.jar 檔案之間建立連接,這還可以在將滑鼠懸停在方法的實體上時在快速預覽中啟用對匯入的方法和類的描述(來自 Javadoc)。
參考:https : //stackoverflow.com/a/91514/15743238
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/314023.html
