[發明專利]代碼注釋生成方法及裝置

在審

• 申請號: 202011322316.4
• 申請日: 2020-11-23
• 公開（公告）號: CN112416429A
• 公開（公告）日: 2021-02-26
• 發明（設計）人: 唐小妮
• 申請（專利權）人: 平安普惠企業管理有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F8/41;G06F16/953
• 代理公司: 廣州三環專利商標代理有限公司 44202
• 代理人: 熊永強

1.一種代碼注釋生成方法，其特征在于，所述方法包括：

獲取目標代碼的注釋配置文件，所述注釋配置文件包括識別關鍵字和目標注釋方式；

基于所述識別關鍵字，從所述目標代碼中獲取目標內容；

基于所述目標注釋方式，生成所述目標內容的注釋文本；

將所述注釋文本添加至所述目標代碼的頂部。

2.根據權利要求1所述的方法，其特征在于，所述方法還包括：

確定所述目標代碼的編程語言；

基于所述編程語言，從所述識別關鍵字中確定所述目標代碼的目標關鍵字。

3.根據權利要求2所述的方法，其特征在于，所述注釋配置文件還包括識別范圍；

所述方法還包括：基于所述識別范圍，確定所述目標關鍵字的匹配范圍。

4.根據權利要求3所述的方法，其特征在于，所述基于所述識別關鍵字，從所述目標代碼中獲取目標內容，包括：

將所述匹配范圍內的代碼與所述目標關鍵字進行匹配；

若所述第一代碼與所述目標關鍵字匹配，則從所述第一代碼中獲取所述目標內容，所述匹配范圍內的代碼包括所述第一代碼。

5.根據權利要求2-4任一項所述的方法，其特征在于，所述注釋配置文件還包括第三方組件；

所述方法還包括：查找所述目標代碼中是否包括第一組件，所述第三方組件包括所述第一組件；

若所述目標代碼包括所述第一組件，獲取所述第一組件的第一信息，所述第一信息包括組件名稱、版本號、組件來源、組件功能中的至少一項。

6.根據權利要求5所述的方法，其特征在于，所述基于所述目標注釋方式，生成所述目標內容的注釋文本，包括：

基于所述編程語言，從所述目標注釋方式中選取第一注釋方式，所述第一注釋方法為支持所述編程語言的注釋方式；

基于所述第一注釋方式，生成所述目標內容和/或所述第一信息的注釋文本。

7.根據權利要求1-6任一項所述的方法，其特征在于，所述方法還包括：

基于git hooks檢測所述目標代碼；

在所述目標代碼的頂部包括所述注釋文本時，提交所述目標代碼。

8.一種代碼注釋生成裝置，其特征在于，所述裝置包括：

獲取單元，用于獲取目標代碼的注釋配置文件，所述注釋配置文件包括識別關鍵字和目標注釋方式；

所述獲取單元，還用于基于所述識別關鍵字，從所述目標代碼中獲取目標內容；

生成單元，用于基于所述目標注釋方式，生成所述目標內容的注釋文本；

添加單元，用于將所述注釋文本添加至所述目標代碼的頂部。

9.一種計算機設備，其特征在于，所述計算機設備包括處理器、存儲器、通信接口，以及一個或多個程序，所述一個或多個程序被存儲在所述存儲器中，并且被配置由所述處理器執行，所述程序包括用于執行如權利要求1-7任一項所述的方法中的步驟的指令。

10.一種計算機可讀存儲介質，其特征在于，所述計算機可讀存儲介質包括存儲用于數據交換的計算機程序，所述計算機程序被處理器執行時實現如權利要求1-7任一項所述的方法。