本申請(qǐng)公開了一種代碼注釋文檔的生成方法，所述代碼注釋文檔的生成方法包括：接收注釋生成請(qǐng)求，并確定所述注釋生成請(qǐng)求對(duì)應(yīng)的目標(biāo)代碼文件；將所述目標(biāo)代碼文件解析為Psi樹，并根據(jù)所述Psi樹確定待注釋文本；利用注釋字典生成所述待注釋文本對(duì)應(yīng)的注釋內(nèi)容，并根據(jù)所述注釋內(nèi)容生成所述目標(biāo)代碼文件的注釋文檔。本申請(qǐng)能夠?qū)崿F(xiàn)自動(dòng)生成代碼注釋文檔，提高代碼注釋文檔的生成效率。本申請(qǐng)還公開了一種代碼注釋文檔的生成裝置、一種電子設(shè)備及一種存儲(chǔ)介質(zhì)，具有以上有益效果。

技術(shù)領(lǐng)域

本申請(qǐng)涉及計(jì)算機(jī)技術(shù)領(lǐng)域，特別涉及一種代碼注釋文檔的生成方法、裝置、一種電子設(shè)備及一種存儲(chǔ)介質(zhì)。

背景技術(shù)

代碼注釋文檔是對(duì)于代碼內(nèi)容的注釋說明，通過代碼注釋文檔可以從程序源代碼中獲取類、方法、參數(shù)、返回值、成員等說明信息，從而生成和源代碼對(duì)應(yīng)的API接口文檔。良好、完備和詳細(xì)的代碼注釋文檔有助于開發(fā)人員更方便、更快速、更準(zhǔn)確的了解代碼，使得代碼閱讀者不需要閱讀源代碼就能知道對(duì)應(yīng)方法或者類的具體作用和功能。代碼注釋文檔也可以幫助API的調(diào)用者方便書寫調(diào)用代碼。

相關(guān)技術(shù)中，代碼注釋文檔完全依靠開發(fā)人員手動(dòng)維護(hù)，效率較低。當(dāng)項(xiàng)目較大時(shí)，代碼注釋文檔的維護(hù)往往需要占用開發(fā)較多時(shí)間。

因此，如何實(shí)現(xiàn)自動(dòng)生成代碼注釋文檔，提高代碼注釋文檔的生成效率是本領(lǐng)域技術(shù)人員目前需要解決的技術(shù)問題。

發(fā)明內(nèi)容

本申請(qǐng)的目的是提供一種代碼注釋文檔的生成方法、裝置、一種電子設(shè)備及一種存儲(chǔ)介質(zhì)，能夠?qū)崿F(xiàn)自動(dòng)生成代碼注釋文檔，提高代碼注釋文檔的生成效率。

為解決上述技術(shù)問題，本申請(qǐng)?zhí)峁┮环N代碼注釋文檔的生成方法，該代碼注釋文檔的生成方法包括：

接收注釋生成請(qǐng)求，并確定所述注釋生成請(qǐng)求對(duì)應(yīng)的目標(biāo)代碼文件；

將所述目標(biāo)代碼文件解析為Psi樹，并根據(jù)所述Psi樹確定待注釋文本；

利用注釋字典生成所述待注釋文本對(duì)應(yīng)的注釋內(nèi)容，并根據(jù)所述注釋內(nèi)容生成所述目標(biāo)代碼文件的注釋文檔。

可選的，根據(jù)所述Psi樹確定待注釋文本包括：

從所述Psi樹中的PsiClass對(duì)象中獲取類名，確定所述PsiClass對(duì)象中的PsiMethod對(duì)象；

將所述類名和所述PsiMethod對(duì)象的方法簽名設(shè)置為所述待注釋文本。

可選的，利用注釋字典生成所述待注釋文本對(duì)應(yīng)的注釋內(nèi)容，并根據(jù)所述注釋內(nèi)容生成所述目標(biāo)代碼文件的注釋文檔，包括：

利用注釋字典生成所述類名對(duì)應(yīng)的注釋內(nèi)容；

利用所述注釋字典生成所述方法簽名對(duì)應(yīng)的注釋內(nèi)容；

拼接所述類名對(duì)應(yīng)的注釋內(nèi)容和所述方法對(duì)應(yīng)的注釋內(nèi)容，生成所述目標(biāo)代碼文件的注釋文檔。

可選的，利用所述注釋字典生成所述方法簽名對(duì)應(yīng)的注釋內(nèi)容，包括：

獲取所述PsiMethod對(duì)象的方法名稱，并利用所述注釋字典生成所述方法名稱對(duì)應(yīng)的注釋內(nèi)容；

獲取所述PsiMethod對(duì)象的參數(shù)，并利用所述注釋字典生成所述參數(shù)對(duì)應(yīng)的注釋內(nèi)容；

獲取所述PsiMethod對(duì)象的返回值類型，并利用所述注釋字典生成所述返回值類型對(duì)應(yīng)的注釋內(nèi)容。

可選的，所述注釋字典的生成過程包括：

獲取樣本代碼文件，確定所述樣本代碼文件中的代碼文本；其中，所述代碼文本包括類名、方法名和參數(shù)名中的任一項(xiàng)或任幾項(xiàng)的組合；

利用所述樣本注釋文檔生成所述代碼文本對(duì)應(yīng)的注釋文本；