一种程序代码注释管理方法.docx
- 文档编号:9137824
- 上传时间:2023-02-03
- 格式:DOCX
- 页数:13
- 大小:84.02KB
一种程序代码注释管理方法.docx
《一种程序代码注释管理方法.docx》由会员分享,可在线阅读,更多相关《一种程序代码注释管理方法.docx(13页珍藏版)》请在冰豆网上搜索。
一种程序代码注释管理方法
说明书摘要
本发明公开了一种程序代码注释的管理方法及装置。
其中,所述程序代码注释的管理方法,包括:
分析程序代码获取注释与程序代码的关联索引或从注释库中获取注释与程序代码的关联索引;根据所述关联索引对独立的注释进行与程序代码的同步处理。
所述程序代码注释管理装置,包括:
代码输入输出模块、注释输入输出模块、代码注释关联模块、代码存储模块、注释存储模块。
通过本发明的方法和装置,简单解决了程序代码注释独立管理的问题,提高了程序开发的效率。
摘要附图
权利要求书
1、一种程序代码注释的管理方法,其特征在于,包括:
获取注释与程序代码的关联索引;
根据所述关联索引对独立的注释进行同步处理。
2、根据权利要求1所述的方法,其特征在于,所述的获取注释与程序代码的关联索引包括:
分析所述的程序代码获取注释与程序代码的关联索引或从注释库中获取注释与程序代码的关联索引。
3、根据权利要求1或2所述的方法,其特征在于,所述的关联索引包括下列中的一种或多种组合:
显式关联索引、程序代码的库名、程序代码的行号、程序代码的符号。
4、根据权利要求1所述的方法,其特征在于,所述的根据所述关联索引对独立的注释进行同步处理包括:
根据所述的关联索引获取对应的注释;
根据所述的关联索引在程序代码的对应位置输出注释。
5、根据权利要求1所述的方法,其特征在于,所述的根据所述关联索引对独立的注释进行同步处理包括:
根据所述的关联索引获取对应的注释;
删除所述的注释。
6、根据权利要求1所述的方法,其特征在于,所述的根据所述关联索引对独立的注释进行同步处理包括:
输入所述的关联索引对应的注释;
存储所述的关联索引和所述的注释。
7、根据权利要求1所述的方法,其特征在于,所述的根据所述关联索引对独立的注释进行同步处理包括:
根据所述的关联索引获取对应的注释;
将所述的注释插入到所述的关联索引对应的程序代码的位置上。
8、一种程序代码注释的管理装置,其特征在于,包括:
代码输入输出模块,用于程序代码的输入输出处理;
注释输入输出模块,用于注释的输入输出处理;
代码注释关联模块,用于程序代码和注释的映射处理,所述映射处理包括:
代码注释关联模块根据关联索引进行映射,同时通知代码输入输出模块或注释输入输出模块进行处理。
9、根据权利要求8所述的装置,其特征在于,所述的一种程序代码注释管理的装置进一步包括:
代码存储模块,用于存储程序代码;
注释存储模块,用于存储注释和关联索引。
说明书
一种程序代码注释的管理方法及装置
技术领域
本发明涉及计算机软件领域,尤其涉及在软件开发领域的程序代码注释的管理方法及装置。
背景技术
随着人类各种应用以及硬件芯片技术的发展,各种应用软件越来越复杂和庞大,应用软件一般是由程序代码经过编译器转化的硬件处理单元能够识别的文件组成。
复杂的软件需要开发大量的复杂的程序代码,因此程序代码管理问题已经变得日益突出,尤其在多人开发团队中的程序代码格式难以统一,减低程序代码可读性和可维护性问题,代码检视协调困难。
程序代码一般是文本格式,程序代码通常为了增加代码的可读性以及可维护性包含了注释,注释通常是对程序代码的解释和说明。
注释和程序代码是作为一个整体存储和处理的。
注释是程序代码可读性和可维护性的重要因素,注释不统一、过多注释都影响了程序的可读性以及可维护性,但是目前各种注释都是嵌入在程序代码文件中的,尤其是随着程序代码不断的庞大,程序代码和代码注释的完全耦合在一个整体中已经严重影响了程序代码的可读性和可维护性,降低了软件程序代码开发效率,提高了软件成本。
代码检视是程序代码开发中的一个重要过程,代码检视就是开发人员互相检视对方开发的代码并且给出修改提示注释或批注,但是目前程序代码是无格式的文本,检视批注不能嵌入到程序代码中去,这样就需要手工将检视批注对应到指定的程序代码,这样显著降低程序开发团队合作效率,尤其是随着程序代码修改和变动,手工对应更加难以处理。
为了解决上述的一些缺陷,提高程序开发的效率,以及降低软件成本,本发明提供一种方法,用来管理程序代码注释,实现程序代码和注释的独立存储和同步处理。
发明内容
鉴于上述现有技术所存在的问题,本发明实施例的目的是,一种程序代码注释的管理方法及装置,用于解决注释嵌入在程序代码中难以管理的问题,从而实现注释和程序代码的独立存储和同步处理的机制,提高程序代码的开发效率,降低软件的成本。
上述目的是通过以下技术方案实现:
本发明实施例提供了一种程序代码注释的管理方法,包括:
获取注释与程序代码的关联索引;
根据所述关联索引对独立的注释进行同步处理。
上述的获取注释与程序代码的关联索引包括:
分析所述的程序代码获取注释与程序代码的关联索引。
上述的获取注释与程序代码的关联索引还包括:
从注释库中获取注释与程序代码的关联索引。
上述的关联索引包括下列中的一种或多种组合:
显式关联索引、程序代码的库名、程序代码的行号、程序代码的符号。
上述的根据所述关联索引对独立的注释进行同步处理包括:
根据所述的关联索引获取对应的注释;
根据所述的关联索引在程序代码的对应位置输出注释。
或
根据所述的关联索引获取对应的注释;
删除所述的注释。
或
输入所述的关联索引对应的注释;
存储所述的关联索引和所述的注释。
或
根据所述的关联索引获取对应的注释;
将所述的注释插入到所述的关联索引对应的程序代码的位置上。
本发明实施例又提供了一种程序代码注释的管理装置,包括:
代码输入输出模块,用于程序代码的输入输出处理;
注释输入输出模块,用于注释的输入输出处理;
代码注释关联模块,用于程序代码和注释的映射处理,所述映射处理包括:
代码注释关联模块根据关联索引进行映射,同时通知代码输入输出模块或注释输入输出模块进行处理。
上述的一种程序代码注释的管理装置还可以包括:
代码存储模块,用于存储程序代码;
注释存储模块,用于存储注释和关联索引。
由上述本发明实施例提供的技术方案可以看出,本发明实施例提供了一种程序代码注释管理的方法及装置,解决了注释嵌入在程序代码中的一些缺陷,提高程序开发的效率,以及降低软件成本。
附图说明
图1为本发明的程序代码管理的应用环境图;
图2为本发明的程序代码管理的装置图;
图3为本发明的代码注释管理中的同步输出注释示意图;
图4为本发明的代码注释管理中的给程序代码增加注释示意图;
图5为本发明的将独立的注释合并到程序代码里的示意图;
图6为本发明的将程序代码包含的注释分离出来的示意图。
具体实施方式
下面结合附图对本发明的实施方式进行详细说明。
首先,介绍程序代码注释的管理方法的即本发明的应用环境,请参阅附图1,程序代码注释的管理方法在代码注释管理程序中实现,代码注释管理程序是实现代码注释管理的指令集合,代码注释管理程序装载在102存储单元中,101软件处理单元负责执行代码注释管理程序,即101软件处理单元从102存储单元获取所述指令然后执行所述的指令,101软件处理单元可以根据所述的代码注释管理程序的指令从104输入单元中接收输入,101软件处理单元还可以根据所述的代码注释管理程序的指令将执行结果输出到103输出单元,进一步,101软件处理单元还将从104输入单元接收到的输入存储到102存储单元中。
其中,101软件处理单元具体实现包括CPU(CentralProcessingUnit,中央处理单元)等,102存储单元具体实现包括内存等,103输出单元具体实现包括显示器、显示终端等,104输入单元具体实现包括键盘、鼠标、手写笔等。
101软件处理单元、102存储单元、103输出单元以及104输入单元协调合作,构成了代码注释管理程序的基本运行环境。
代码注释管理程序负责同步输出注释、同步删除注释、同步输入注释、同步合并注释以及同步分离注释。
程序代码和注释是独立存储的,即注释不是嵌入在程序代码中的,程序代码和注释通过关联索引进行映射或关联,关联索引包括显式关联索引、程序代码的库名、程序代码的行号、程序代码的符号中的一种或多种组合,其中程序代码的库名具体包括程序代码文件名、程序代码数据库名等。
同步输出注释负责在程序代码的对应位置输出或显示注释,主要包括:
分析程序代码获取关联索引或从注释库中获取关联索引,然后从注释库中获取关联索引对应的注释,然后根据关联索引在程序代码的对应位置输出或显示注释。
同步删除注释负责从注释库中删除注释,主要包括:
分析程序代码获取待删除注释的关联索引或从注释库中获取待删除注释的关联索引,根据关联索引从注释库中获取对应的注释;然后从注释库中删除所述的注释和关联索引,如果程序代码中存在显式关联索引,则在程序代码中同步删除显式关联索引。
同步输入注释主要包括:
分析程序代码获取待增加注释的程序代码的关联索引,输入或编辑关联索引对应的注释;存储所述的关联索引和所述的注释。
合并注释主要包括:
从注释库中获取待合并注释的关联索引,根据所述的关联索引从注释库中获取对应的注释;将所述的注释插入到所述的关联索引对应的程序代码的位置上。
分离注释主要包括:
分析程序代码获取程序代码中的注释以及注释对应的关联索引;存储所述的关联索引和所述的注释;删除程序代码中的注释,如果是显式索引,则在程序代码中增加显式索引。
通过上述的代码注释管理程序,程序代码和注释存储在不同的库中,代码注释管理程序负责程序代码和注释的关联或对应,即将指定程序代码与指定的注释互相对应起来成为一个整体,同时可以方便的将程序代码中的注释分离出来独立存储,也可以将独立的注释合并到程序代码中去,从而实现独立存储的程序代码和注释能够同步处理,实现程序代码和注释灵活管理,大大提高程序代码开发的效率。
需要说明的是,上述应用环境具体实现可以多种多样,包括但不限于个人计算机、服务器、手持终端、笔记本电脑。
本发明还描述了程序代码管理的装置,请参阅附图3,程序代码管理的装置包括:
201代码输入输出模块、202注释输入输出模块、203代码注释关联模块、204代码存储模块和205注释存储模块。
201代码输入输出模块负责程序代码的输入输出处理,通常称之为代码编辑,具体包括:
从输入单元接收程序代码的输入,并将输入的程序代码存储到204代码存储模块。
201代码输入输出模块具体实现包括但不限于编辑窗口或文本框或编辑框。
202注释输入输出模块负责注释的输入输出处理,具体包括:
从输入单元接收注释的输入,并将输入的注释存储到205注释存储模块。
202注释输入输出模块具体实现包括但不限于编辑窗口或文本框或编辑框。
203代码注释关联模块负责程序代码和注释的映射,203代码注释关联模块根据关联索引进行映射,同时通知201代码输入输出模块或202注释输入输出模块进行处理。
显式关联索引指在程序代码中显式地增加一个关联索引标记,例如在C预言代码中显式地增加一个标记,如:
/*注释#00026*/。
203代码注释关联模块根据关联索引将程序代码对应到指定的注释或将注释对应到指定的程序代码。
一般的,如果一段程序代码或一行程序代码或一个程序代码符号存在注释,203代码注释关联模块从所述的一段程序代码或一行程序代码或一个程序代码符号获取关联索引并将关联索引传递给202注释输入输出模块,202注释输入输出模块根据关联索引输入或输出其对应的注释。
204代码存储模块负责存储程序代码,例如:
204代码存储模块实现程序代码读写,代码存储模块从磁盘、数据库等存储功能体上读取程序代码或者将程序代码写入存储功能体中。
205注释存储模块负责将注释和关联索引作为注释库存储,注释库存储在磁盘、数据库等存储功能体上。
204代码存储模块和205注释存储模块实现了程序代码和注释的独立存储,201代码输入输出模块和202注释输入输出模块通过203代码注释关联模块对程序代码和注释进行同步处理。
这样可以方便实现程序代码和注释互不影响,同时也可以容易实现检视批注的自动对应以及同步管理,提高了程序代码的可维护性以及可读性,降低程序代码的开发成本。
下面是程序代码管理步骤以及相关操作,同时结合上面装置实施例的详细描述。
附图3描述了代码注释管理中的同步输出注释的步骤,具体包括:
步骤301,获取关联索引。
获取关联索引包括自动触发或输入命令触发分析程序代码,然后根据分析获取关联索引,输入触发包括键盘按键输入、鼠标按键输入等,自动触发包括初始载入程序代码、更新程序代码等。
具体实现包括:
代码输入输出模块接收输入焦点,代码输入输出模块接收的输入焦点包括快捷键、鼠标按键等操作信息。
代码输入输出模块将输入焦点信息以及程序代码传递给代码注释关联模块,代码注释关联模块分析程序代码,获取输入焦点对应的关联索引。
例如:
代码输入输出模块获取快捷键或鼠标按键的位置,所述的位置包括但不限于行号、列号,代码注释关联模块分析程序代码,根据输入焦点的位置对应的代码对象构造关联索引。
所述的代码对象包括但不局限于当前的程序代码文件名或库名、行号、程序代码符号或显式关联索引。
代码注释关联模块将关联索引传递给注释输入输出模块。
步骤302,根据关联索引获取注释。
注释输入输出模块根据关联索引通过注释存储模块在注释库中查找对应的注释,如果存在对应的注释,注释输入输出模块从注释存储模块获取注释。
步骤303,输出注释信息。
注释输入输出模块通常将注释输出到编辑窗口或文本框或编辑框,然后通过输出单元将包含注释的编辑窗口或文本框或编辑框显示出来。
通过附图3所述的方法,程序代码开发时可以按需输出或显示指定的注释,可以使程序代码更加整洁,同时注释更加具有针对性,提高了程序代码的可读性和可维护性。
附图4描述了代码注释管理中的给程序代码增加注释的步骤,具体包括:
步骤401、接收增加注释命令。
下发增加注释的命令,接收增加注释命令,并且获取待增加注释的代码对象。
例如:
代码输入输出模块接收来自菜单或按钮的命令,在当前输入焦点位置或对选中的代码对象增加注释。
所述的注释包括对程序代码进行解释或说明的注释,还可以包括检视批注。
代码输入输出模块通知代码注释关联模块分析代码和增加注释。
所述选中的代码对象包括但不限于代码符号,所述的代码符号包括但不限于函数名、全局变量、类型声明、宏定义、控制语句、条件语句等。
步骤402、获取关联索引。
分析程序代码,然后根据分析获取关联索引。
具体实现包括:
代码注释关联模块分析需要增加注释的程序代码对象,然后根据程序代码对象构造关联索引,代码注释关联模块还可以通知代码输入输出模块为程序代码增加显式的关联索引,比如代码输入输出模块在需要增加注释的程序代码对象的周围增加用于关联索引的注释,如:
//注释#0009。
代码注释关联模块将关联所以传递给注释输入输出模块。
步骤403、编辑注释。
根据关联索引增加注释,注释是手工输入的数据信息,最典型就是字符串。
所述的注释可以是对关联索引所指的程序代码的说明或解释,也可以是对关联索引所指的程序代码的检视批注。
具体实现如:
注释输入输出模块接收输入的数据作为注释,然后将注释通过注释存储模块存储到注释库中。
注释输入输出模块可以通过输入窗口或编辑框或文本框接收注释。
步骤404、存储注释。
注释输入输出模块将注释以及关联索引传递给注释存储模块,注释存储模块存储注释以及关联索引到注释库。
注释库可以为文件,也可以为数据库。
存储方式取决具体实现。
附图5描述了代码注释管理中的将独立的注释合并到程序代码里的步骤,具体包括:
步骤501、获取关联索引以及注释。
注释输入输出模块通过注释存储模块从注释库中获取关联索引以及注释,注释输入输出模块将关联索引以及注释传递给代码注释关联模块。
步骤502、获取关联索引在程序代码中对应的位置。
代码注释关联模块分析程序代码,确定关联索引在程序代码中对应的位置,然后通知代码输入输出模块在指定位置增加注释。
步骤503、在程序代码对应的位置插入注释。
代码输入输出模块在程序代码的指定位置插入注释。
代码输入输出模块根据程序代码的语言特征增加符合程序代码语言格式的注释。
例如:
如果程序代码是C语言,则插入的是/**/格式的注释。
附图6描述了代码注释管理中的将程序代码包含的注释分离出来的步骤,具体包括:
步骤601、解析程序代码获取关联索引和注释。
代码输入输出模块载入程序代码,代码输入输出模块将程序代码交给代码注释关联模块进行分析,代码注释关联模块通过词法和语法分析得到程序代码中的注释以及注释所在位置或注释对应的程序代码对象。
注释关联模块根据注释所在位置或注释对应的程序代码对象构造关联索引。
注释关联模块通知注释输入输出模块存储注释以及关联索引。
步骤602、存储注释以及关联索引。
注释输入输出模块存储注释以及关联索引到注释存储模块。
步骤603、移除程序代码中的注释。
注释关联模块通知代码输入输出模块移除指定注释,注释关联模块还可以通知代码输入输出模块增加显式关联索引。
代码输入输出模块在程序代码的指定位置移除指定注释,代码输入输出模块还可以在程序代码的指定位置增加显式关联索引。
通常显式关联索引作为注释添加在程序代码中。
以上所述,仅为本发明实施例较佳的具体实施方式,但本发明实施例的保护范围并不局限于此,任何熟悉本技术领域的技术人员在本发明实施例揭露的技术范围内,可轻易想到的变化或替换,都应涵盖在本发明实施例的保护范围之内。
因此,本发明实施例的保护范围应该以权利要求的保护范围为准。
说明书附图
图1
图2
图3
图4
图5
图6
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 一种 程序代码 注释 管理 方法