[發明專利]一種提高開源代碼注釋率及注釋質量的方法

有效

• 申請號: 201810177965.6
• 申請日: 2018-03-05
• 公開（公告）號: CN108459873B
• 公開（公告）日: 2021-09-24
• 發明（設計）人: 王懷民;王濤;於杰;尹剛;余躍;范強;曾令斌;張迅暉;李志星;曾雅蓉;王威;劉晉澤
• 申請（專利權）人: 中國人民解放軍國防科技大學
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 長沙國科天河知識產權代理有限公司 43225
• 代理人: 董惠文

本發明提供一種提高開源代碼注釋率及注釋質量的方法，流程如下：1、建立一個代碼數據服務器,對開源代碼進行預處理；2、對代碼片段的難易程度劃分等級；3、對用戶知識掌握程度劃分等級；4、將代碼片段按照等級推送給相應等級的用戶，讓用戶進行相應操作；5、向用戶推送系統為該段代碼自動產生的問題，用戶進行回答，若回答正確，則顯示用戶回答正確，并高亮用戶答案；若回答不正確，則顯示用戶回答錯誤，并提供參考答案。本發明通過多次的循環推送后形成了一批具有注釋的代碼片段和高質量的代碼注釋，為代碼復用提供了豐富的資源，有效的提高開發者在進行代碼檢索的效率以及軟件開發過程中的代碼復用率,極大的提高了開發效率。

技術領域

本發明涉及一種提高開源代碼注釋率及注釋質量的方法。

背景技術

目前互聯網上存在著大量的開源軟件與代碼，開源軟件已經被廣泛的應用在各個領域，并發揮著至關重要的作用。因為開源的存在，開發者可以在開發自己項目的時候引入開源項目，實現一些基本功能，而不需要重復造輪子，節約了大量的時間，縮短開發周期；同時，開發者為了更好的使用開源項目，會向開源項目作出貢獻，使開源項目的功能越加強大，從而吸引更多的用戶去使用開源項目，形成了一個良性循環。

目前大多數搜索引擎和開源社區通過搜索關鍵字獲取開源代碼，如此，軟件開發者就可以分析和使用開源代碼；然而這些關鍵字大多是基于代碼的，因此，當開發者不知道如何實現某個方法時，就無法通過搜索代碼來得到自己想要的代碼片段；與此同時，當用戶自身能力不足，在獲得開源代碼后，可能遇到代碼注釋率不高或注釋質量不高的問題，導致用戶需要花費大量的時間去分析代碼，降低了開發效率；所以提高代碼注釋率以及注釋質量是提高代碼復用率、開發效率、軟件檢索效率的重要途徑。

眾包是目前互聯網上一種比較流行的機制，這個概念2006年首次提出，指的是一個公司或機構把過去由員工執行的工作任務，以自由自愿的形式外包給非特定的大眾網絡的做法。眾包模式可以最大限度利用大眾力量，以更高的效率、更低的成本滿足生產及生活服務需求，促進生產方式變革，開拓集智創新的新途徑，通過群體的力量，為更廣大的群體服務。眾包是一種有效的處理大量數據的方法，在線學習平臺Duolingo通過眾包的方式向用戶推送合適的語言文本，讓用戶來幫助翻譯，同時讓用戶對語言及翻譯文本進行匹配，既幫助用戶提升語言能力，也完成了大量的語料的翻譯工作，形成了大量高質量的翻譯文本數據，并與原始語料形成了關聯。

目前互聯網上還沒有一個以代碼為主體的在線學習平臺，也沒有一個平臺專門針對代碼進行注釋，導致開發者在開發的過程中不能有效的通過自然語言來搜索自己想要的代碼片段，在分析源碼的時候耗費大量的時間；如果有一個平臺能夠以眾包的方式為代碼片段或開源項目形成高注釋率和高注釋質量的代碼，既極大的節約了成本、又完成了代碼標注的目的，這對開發者進行學習、代碼檢索和代碼復用提供了極大的便利，大大提升開發效率和開發質量。

因此，如何為開發人員提供高注釋率、高注釋質量的代碼，是本領域技術人員極為關注的重要問題。

發明內容

本發明的目的在于針對現有平臺覆蓋方面的不足，提供一種提高開源代碼注釋率及注釋質量的方法，通過不同用戶對同一段代碼進行閱讀、注釋以及一些列用戶行為，形成持續迭代的代碼問答體系，進而生成高注釋率、高注釋質量的代碼片段及開源代碼。

本發明的技術方案包括以下步驟：

步驟1、建立一個代碼數據服務器(Code Data Server),從互聯網的主要代碼托管平臺中采集開源代碼，并對開源代碼進行預處理；

步驟2、對代碼片段的難易程度劃分等級，代碼等級分為簡單、中等、較難、很難四個等級；

步驟3、對用戶知識掌握程度劃分等級，用戶等級分為基礎、入門、熟悉、精通四個等級；

步驟4、將四個等級的代碼片段按照等級推送給相應等級的用戶，讓用戶進行相應操作；