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

在審

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

本申請實施例提供了一種代碼注釋生成方法及裝置，該方法包括：獲取目標代碼的注釋配置文件，所述注釋配置文件包括識別關鍵字和目標注釋方式；基于所述識別關鍵字，從所述目標代碼中獲取目標內容；基于所述目標注釋方式，生成所述目標內容的注釋文本；將所述注釋文本添加至所述目標代碼的頂部。本申請通過注釋配置文件中識別關鍵字和目標注釋方式，自動生成目標代碼的注釋文本，并將注釋文本添加至該目標代碼的頂部，可以提高程序代碼的可讀性和可維護性，從而提高了軟件程序代碼的開發效率。

技術領域

本申請涉及計算機技術領域，尤其涉及一種代碼注釋生成方法及裝置。

背景技術

隨著IT行業的快速發展，各種應用軟件越來越復雜和龐大，復雜的軟件需要開發大量的復雜的程序代碼。為了增加代碼的可讀性以及可維護性，程序員在開發過程中會對代碼進行注釋，注釋通常是對程序代碼的解釋和說明。但是注釋是由程序員人工添加的，且每個程序員有自己的注釋方式，不利于后來的開發或者維護人員的理解，并且當程序代碼修改和變動，也需要手動修改注釋，降低程序開發團隊合作效率。

發明內容

本申請實施例提供了一種代碼注釋生成方法及裝置，能夠提高程序代碼的可讀性和可維護性，從而提高軟件程序代碼的開發效率。

第一方面，本申請實施例提供一種代碼注釋生成方法，所述方法包括：

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

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

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

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

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

可選的，所述注釋配置文件還包括識別范圍；所述方法還包括：基于所述識別范圍，確定所述目標關鍵字的匹配范圍。

可選的，所述基于所述識別關鍵字，從所述目標代碼中獲取目標內容，包括：將所述匹配范圍內的代碼與所述目標關鍵字進行匹配；若所述第一代碼與所述目標關鍵字匹配，則從所述第一代碼中獲取所述目標內容，所述匹配范圍內的代碼包括所述第一代碼。

可選的，所述注釋配置文件還可以包括第三方組件；所述方法還包括：查找所述目標代碼中是否包括第一組件，所述第三方組件包括所述第一組件；若所述目標代碼包括第一組件，獲取所述第一組件的第一信息，所述第一信息包括組件名稱、版本號、組件來源、組件功能中的至少一項。

可選的，所述基于所述目標注釋方式，生成所述目標內容的注釋文本，包括：基于所述編程語言，從所述目標注釋方式中選取第一注釋方式，所述第一注釋方法為支持所述編程語言的注釋方式；基于所述第一注釋方式，生成所述目標內容和/或所述第一信息的注釋文本。

可選的，所述方法還包括：基于git hooks檢測所述目標代碼；在所述目標代碼的頂部包括所述注釋文本時，提交所述目標代碼。

第二方面，本申請實施例提供一種代碼注釋生成裝置，所述裝置包括：

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

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

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

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

可選的，所述裝置還包括確定單元，所述確定單元，用于確定所述目標代碼的編程語言；