[发明专利]一种程序代码注释的管理方法及装置

说明书

技术领域

本发明涉及计算机软件领域，尤其涉及在软件开发领域的程序代码注释的管理方法及装置。

背景技术

随着人类各种应用以及硬件芯片技术的发展，各种应用软件越来越复杂和庞大，应用软件一般是由程序代码经过编译器转化的硬件处理单元能够识别的文件组成。复杂的软件需要开发大量的复杂的程序代码，因此程序代码管理问题已经变得日益突出，尤其在多人开发团队中的程序代码格式难以统一，减低程序代码可读性和可维护性问题，代码检视协调困难。

程序代码一般是文本格式，程序代码通常为了增加代码的可读性以及可维护性包含了注释，注释通常是对程序代码的解释和说明。注释和程序代码是作为一个整体存储和处理的。注释是程序代码可读性和可维护性的重要因素，注释不统一、过多注释都影响了程序的可读性以及可维护性，但是目前各种注释都是嵌入在程序代码文件中的，尤其是随着程序代码不断的庞大，程序代码和代码注释的完全耦合在一个整体中已经严重影响了程序代码的可读性和可维护性，降低了软件程序代码开发效率，提高了软件成本。

代码检视是程序代码开发中的一个重要过程，代码检视就是开发人员互相检视对方开发的代码并且给出修改提示注释或批注，但是目前程序代码是无格式的文本，检视批注不能嵌入到程序代码中去，这样就需要手工将检视批注对应到指定的程序代码，这样显著降低程序开发团队合作效率，尤其是随着程序代码修改和变动，手工对应更加难以处理。

为了解决上述的一些缺陷，提高程序开发的效率，以及降低软件成本，本发明提供一种方法，用来管理程序代码注释，实现程序代码和注释的独立存储和同步处理。

发明内容

鉴于上述现有技术所存在的问题，本发明实施例的目的是，一种程序代码注释的管理方法及装置，用于解决注释嵌入在程序代码中难以管理的问题，从而实现注释和程序代码的独立存储和同步处理的机制，提高程序代码的开发效率，降低软件的成本。

上述目的是通过以下技术方案实现：

本发明实施例提供了一种程序代码注释的管理方法，包括：

获取注释与程序代码的关联索引；

根据所述关联索引对独立的注释进行同步处理。

上述的获取注释与程序代码的关联索引包括：分析所述的程序代码获取注释与程序代码的关联索引。

上述的获取注释与程序代码的关联索引还包括：从注释库中获取注释与程序代码的关联索引。

上述的关联索引包括下列中的一种或多种组合：显式关联索引、程序代码的库名、程序代码的行号、程序代码的符号。

上述的根据所述关联索引对独立的注释进行同步处理包括：

根据所述的关联索引获取对应的注释；

根据所述的关联索引在程序代码的对应位置输出注释。

或

根据所述的关联索引获取对应的注释；

删除所述的注释。

或

输入所述的关联索引对应的注释；

存储所述的关联索引和所述的注释。

或

根据所述的关联索引获取对应的注释；

将所述的注释插入到所述的关联索引对应的程序代码的位置上。

本发明实施例又提供了一种程序代码注释的管理装置，包括：

代码输入输出模块，用于程序代码的输入输出处理；

注释输入输出模块，用于注释的输入输出处理；

代码注释关联模块，用于程序代码和注释的映射处理，所述映射处理包括：代码注释关联模块根据关联索引进行映射，同时通知代码输入输出模块或注释输入输出模块进行处理。

上述的一种程序代码注释的管理装置还可以包括：

代码存储模块，用于存储程序代码；

注释存储模块，用于存储注释和关联索引。

由上述本发明实施例提供的技术方案可以看出，本发明实施例提供了一种程序代码注释管理的方法及装置，解决了注释嵌入在程序代码中的一些缺陷，提高程序开发的效率，以及降低软件成本。

附图说明

图1为本发明的程序代码管理的应用环境图；

图2为本发明的程序代码管理的装置图；

图3为本发明的代码注释管理中的同步输出注释示意图；

图4为本发明的代码注释管理中的给程序代码增加注释示意图；

图5为本发明的将独立的注释合并到程序代码里的示意图；

图6为本发明的将程序代码包含的注释分离出来的示意图。

具体实施方式