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

权利要求书

1.一种代码注释生成方法，其特征在于，所述方法包括：

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

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

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

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

2.根据权利要求1所述的方法，其特征在于，所述方法还包括：

确定所述目标代码的编程语言；

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

3.根据权利要求2所述的方法，其特征在于，所述注释配置文件还包括识别范围；

所述方法还包括：基于所述识别范围，确定所述目标关键字的匹配范围。

4.根据权利要求3所述的方法，其特征在于，所述基于所述识别关键字，从所述目标代码中获取目标内容，包括：

将所述匹配范围内的代码与所述目标关键字进行匹配；

若所述第一代码与所述目标关键字匹配，则从所述第一代码中获取所述目标内容，所述匹配范围内的代码包括所述第一代码。

5.根据权利要求2-4任一项所述的方法，其特征在于，所述注释配置文件还包括第三方组件；

所述方法还包括：查找所述目标代码中是否包括第一组件，所述第三方组件包括所述第一组件；

若所述目标代码包括所述第一组件，获取所述第一组件的第一信息，所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

6.根据权利要求5所述的方法，其特征在于，所述基于所述目标注释方式，生成所述目标内容的注释文本，包括：

基于所述编程语言，从所述目标注释方式中选取第一注释方式，所述第一注释方法为支持所述编程语言的注释方式；

基于所述第一注释方式，生成所述目标内容和/或所述第一信息的注释文本。

7.根据权利要求1-6任一项所述的方法，其特征在于，所述方法还包括：

基于git hooks检测所述目标代码；

在所述目标代码的顶部包括所述注释文本时，提交所述目标代码。

8.一种代码注释生成装置，其特征在于，所述装置包括：

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

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

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

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

9.一种计算机设备，其特征在于，所述计算机设备包括处理器、存储器、通信接口，以及一个或多个程序，所述一个或多个程序被存储在所述存储器中，并且被配置由所述处理器执行，所述程序包括用于执行如权利要求1-7任一项所述的方法中的步骤的指令。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质包括存储用于数据交换的计算机程序，所述计算机程序被处理器执行时实现如权利要求1-7任一项所述的方法。