[发明专利]代码注释生成方法及装置

说明书

本申请实施例提供了一种代码注释生成方法及装置，该方法包括：获取目标代码的注释配置文件，所述注释配置文件包括识别关键字和目标注释方式；基于所述识别关键字，从所述目标代码中获取目标内容；基于所述目标注释方式，生成所述目标内容的注释文本；将所述注释文本添加至所述目标代码的顶部。本申请通过注释配置文件中识别关键字和目标注释方式，自动生成目标代码的注释文本，并将注释文本添加至该目标代码的顶部，可以提高程序代码的可读性和可维护性，从而提高了软件程序代码的开发效率。

技术领域

本申请涉及计算机技术领域，尤其涉及一种代码注释生成方法及装置。

背景技术

随着IT行业的快速发展，各种应用软件越来越复杂和庞大，复杂的软件需要开发大量的复杂的程序代码。为了增加代码的可读性以及可维护性，程序员在开发过程中会对代码进行注释，注释通常是对程序代码的解释和说明。但是注释是由程序员人工添加的，且每个程序员有自己的注释方式，不利于后来的开发或者维护人员的理解，并且当程序代码修改和变动，也需要手动修改注释，降低程序开发团队合作效率。

发明内容

本申请实施例提供了一种代码注释生成方法及装置，能够提高程序代码的可读性和可维护性，从而提高软件程序代码的开发效率。

第一方面，本申请实施例提供一种代码注释生成方法，所述方法包括：

获取目标代码的注释配置文件，所述注释配置文件包括识别关键字和目标注释方式；

基于所述识别关键字，从所述目标代码中获取目标内容；

基于所述目标注释方式，生成所述目标内容的注释文本；

将所述注释文本添加至所述目标代码的顶部。

可选的，确定所述目标代码的编程语言；基于所述编程语言，从所述识别关键字中确定所述目标代码的目标关键字

可选的，所述注释配置文件还包括识别范围；所述方法还包括：基于所述识别范围，确定所述目标关键字的匹配范围。

可选的，所述基于所述识别关键字，从所述目标代码中获取目标内容，包括：将所述匹配范围内的代码与所述目标关键字进行匹配；若所述第一代码与所述目标关键字匹配，则从所述第一代码中获取所述目标内容，所述匹配范围内的代码包括所述第一代码。

可选的，所述注释配置文件还可以包括第三方组件；所述方法还包括：查找所述目标代码中是否包括第一组件，所述第三方组件包括所述第一组件；若所述目标代码包括第一组件，获取所述第一组件的第一信息，所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

可选的，所述基于所述目标注释方式，生成所述目标内容的注释文本，包括：基于所述编程语言，从所述目标注释方式中选取第一注释方式，所述第一注释方法为支持所述编程语言的注释方式；基于所述第一注释方式，生成所述目标内容和/或所述第一信息的注释文本。

可选的，所述方法还包括：基于git hooks检测所述目标代码；在所述目标代码的顶部包括所述注释文本时，提交所述目标代码。

第二方面，本申请实施例提供一种代码注释生成装置，所述装置包括：

可选的，获取单元，用于获取目标代码的注释配置文件，所述注释配置文件包括识别关键字和目标注释方式；

所述获取单元，还用于基于所述识别关键字，从所述目标代码中获取目标内容；

生成单元，用于基于所述目标注释方式，生成所述目标内容的注释文本；

添加单元，用于将所述注释文本添加至所述目标代码的顶部。

可选的，所述装置还包括确定单元，所述确定单元，用于确定所述目标代码的编程语言；