专利名称：注解插入系统及其方法
注解插入系统及其方法
技术领域：
本发明涉及一种注解插入系统，特别是一种应用于对软件源代码自动插入注解的系统。
背景技术：
在软件设计中，编码阶段和测试阶段是软件开发生命周期中重要的组成部分，这 两个阶段是软件从设想到实现再到最终成品的重要环节。程序开发人员在了解软件源代码 的时候，希望通过一些逻辑和程序语言进行识别，但是在较复杂的软件中不易检查源代码 中的函数正确性。 编码是智能高密集的行为过程，由于程序开发工程师的习惯不同，开发时间紧迫， 开发出来的源代码常常存在缺少注释的情况。在软件测试中分两部分1、验证，即证实源代 码按照要求格式编写，其中源代码注释也是需要验证的重要环节；2、确认，即证实源代码已 实现了需求定义。另外，在软件使用过程中，由于一些原因，可能要对软件进行升级或管理 维护，但是对于非开发人员来说，没有注释的源程序的阅读和管理维护都是非常不方便的。
发明内容
本发明目的在于提供一种注解插入系统，特别是一种应用于对软件源代码自动插 入注解的系统。
本发明提供一种注解插入系统，该系统包括 —查找模块，其用于查找源代码中的函数，该查找模块包括一数据库，其用于存 储与源代码相对应的函数及相关信息；一比对单元，其用于将查找模块查找出的函数与数 据库中函数相比对，并提取比对到的相对应函数相关信息；一存储单元，其用于存储上述比 对单元提取出的函数相关信息； —插入模块，其用于将存储于存储单元上的函数相关信息插入源代码，该插入模
块上设有一整理单元，其用于将存储于存储单元上函数相关信息进行整理成注解。 特别的是，所述源代码为一定标准格式的代码，该源代码为通过语法、参数、功能
检查后并按照一定顺序编排的代码。 特别的是，所述查找模块根据源代码编写的语法、函数的定义及实现原理确定源 代码中的函数。 特别的是，所述数据库内函数与源代码内函数编排方式相一致。 特别的是，所述查找模块在函数数据库内提取的相关信息包括函数名称、作用、
参数信息、返回值。 特别的是，所述整理单元将该函数相关信息依函数名称、作用、参数信息、返回值 四者顺序排列并整理成注解。 本发明还提出一种用注解插入系统的方法，该方法包括下列步骤
(1)查找模块查找源代码中的函数；
(2)比对单元将查找到的函数与数据库中函数进行比对； (3)比对单元提取比对得到的函数的相关信息并存储至存储单元； (4)整理单元将提取出的函数相关信息整理成注解； (5)插入模块将注解插入源代码； (6)判断查找是否结束，如判断结果为"是"，则结束，如判断结果为"否"，则返回步 骤(1)继续进行查找。 与现有技术相比较，本发明通过一查找模块查找软件源代码中函数，查找该函数 相对应的信息，并通过一插入模块将查找的信息整理成注解插入源代码中，实现测试需求 与源代码统一，完善源代码验证测试工作，为后续确认工作做准备。
图1为本发明注解插入系统结构示意图。
图2为本发明注解插入系统的方法流程图。
具体实施方式
参图1所示，为本发明注解插入系统结构示意图。 本发明提供一种注解插入系统，适用于对软件源代码自动插入注解的系统，于本 实施例，所述源代码为一定标准格式的代码，该源代码为通过语法、参数、定义、功能检查后 美化并按照一定顺序编排的代码，该注解插入系统包括 —查找模块l，其用于查找源代码中的函数，该查找模块1根据源代码编写的语 法、函数的定义及实现原理查找源代码中的函数，于本实施例，该查找模块1查找函数的方 法为正则表达式识别法；该查找模块l还包括一数据库ll，其用于存储与源代码相对应的 函数及相关信息，于本实施例，该数据库11中函数与源代码中函数编排方式相一致；一比 对单元12，其用于将查找模块1查找出的函数与数据库11中函数相比对，并提取比对的数 据库11中函数的相关信息，于本实施例，提取的该函数相关信息包括函数名称、作用、参 数信息、返回值；一存储单元13，其用于存储上述比对单元12提取出的函数相关信息；
—插入模块2，其用于将存储于存储单元13上的函数相关信息插入至源代码，该 插入模块2上设有一整理单元21 ，其用于将存储于存储单元13上函数相关信息进行整理成 注解，于本实施例，所述整理单元21将该函数相关信息依函数名称、作用、参数信息、返回 值的顺序进行整理成注解形式。 参图2所示，为本发明注解插入系统的方法流程图。本发明还提供一种注解插入 系统的方法，该方法包括下列步骤 步骤100 :启动该系统，上述查找模块1对源代码顺序查找该源代码中的函数，于 本实施例，所述查找模块1通过正则表达式识别法方法识别函数，并确定函数的起始、结束 位置； 步骤101 :所述查找模块1上比对单元1 2将该查找到的函数与查找模块1上数 据库11中函数进行比对，于本实施例，该比对单元12在源代码的函数中提取关键词，该关 键词包括函数名称、参数信息、返回值，该比对单元12将提取出的关键词与数据库11中函 数相比对，搜索出与源代码中函数相对应的函数及函数相关信息；
步骤102 :比对单元12提取比对得到相对应的函数的相关信息，并存储至上述存 储单元13上，于本实施例，该函数相关信息包括函数名称、作用、参数信息、返回值；
步骤103 :所述插入模块2上整理单元21将提取出的函数相关信息整理成注解， 于本实施例，该整理单元21将该函数相关信息依函数名称、作用、参数信息、返回值的顺序 进行整理成注解； 步骤104 :所述插入模块2将整理后的注解插入至源代码，于本实施例，该插入模 块2将整理的注解插入源代码中函数起始位置。 步骤105 :查找模块判断查找是否结束，如判断结果为"是"，则结束，如判断结果 为"否"则返回步骤100继续进行查找。
权利要求
一种注解插入系统，适用于对软件源代码自动插入注解的系统，其特征在于，该注解插入系统包括一查找模块，其用于查找源代码中的函数，该查找模块包括一数据库，其存储与源代码相对应的函数及相关信息；一比对单元，其用于将查找模块查找出的函数与数据库中函数相比对，并提取查找模块比对到的相对应函数的相关信息；一存储单元，其用于存储上述比对单元提取出的函数相关信息；一插入模块，其用于将存储于存储单元上的函数的相关信息插入源代码，该插入模块上设有一整理单元，其用于将存储于存储单元上函数相关信息进行整理成注解形式。
2. 如权利要求1所述的注解插入系统，其特征在于所述源代码为一定标准格式的代 码，该源代码为通过语法、参数、功能检查后美化并按照一定顺序编排的代码。
3. 如权利要求1所述的注解插入系统，其特征在于所述查找模块根据源代码编写的 语法、函数的定义及实现原理确定源代码中的函数。
4. 如权利要求3所述的注解插入系统，其特征在于所述查找模块查找函数的方法为 正则表达式识别法。
5. 如权利要求2所述的注解插入系统，其特征在于所述数据库内函数与源代码内函 数编排方式相一致。
6. 如权利要求5所述的注解插入系统，其特征在于所述查找模块在函数数据库内提 取的相关信息包括函数名称、作用、参数信息、返回值。
7. 如权利要求1所述的注解插入系统，其特征在于所述整理单元将该函数相关信息 依函数名称、作用、参数信息、返回值的顺序整理成注解。
8. —种注解插入系统的方法，其特征在于，该方法包括下列步骤(1) 查找模块查找源代码中的函数；(2) 比对单元将查找到的函数与数据库中函数进行比对；(3) 比对单元提取比对得到的函数的相关信息并存储至存储单元；(4) 整理单元将提取出的函数相关信息整理成注解；(5) 插入模块将注解插入源代码；(6) 判断查找是否结束，如判断结果为"是"，则结束，如判断结果为"否"，则返回步骤 (1)继续进行查找。
全文摘要
本发明提供一种注解插入系统，该系统包括一查找模块，其用于查找软件源代码中的函数，该查找模块包括一数据库，其用于存储与源代码相对应的函数及相关信息；一比对单元，其用于将查找模块查找出的函数与数据库中函数相比对，并提取查找模块在数据库中查找到的函数的相关信息；一存储单元，其用于存储上述比对单元提取出的函数的相关信息；一插入模块，其用于将上述查找模块查找到的函数相关信息整理成注解并插入至源代码，该插入模块上设有一整理单元，其用于将存储于存储单元上的函数相关信息进行整理成注解。本发明对源代码进行自动插入注解，实现测试需求与源代码统一，完善源代码验证测试工作，为后续确认工作做准备。
文档编号G06F9/44GK101739243SQ20081014760
公开日2010年6月16日 申请日期2008年11月19日 优先权日2008年11月19日
发明者张嘉怡, 杨柳, 齐武 申请人:成都宇达电通有限公司