一种基于关键字检测的代码质量改进方法和系统技术方案

本发明专利技术提出了一种基于关键字检测的代码质量改进方法和系统。所述代码质量改进方法包括：针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance；制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范；在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式。所述系统包括与所述方法步骤对应的模块。方法步骤对应的模块。方法步骤对应的模块。

【技术实现步骤摘要】
一种基于关键字检测的代码质量改进方法和系统


[0001]本专利技术提出了一种基于关键字检测的代码质量改进方法和系统，属于代码处理


技术介绍

[0002]在软件开发过程中，代码质量是至关重要的。为了保证代码的质量，需要使用各种工具和技术进行检测和改进。其中一种常用的方法是基于关键字检测的代码质量改进方法。该方法通过检测代码中的关键字，识别出潜在的问题，并提供相应的解决方案。这些关键字包括编码规范、安全问题、性能问题等。然而，现有技术中的代码质量改进方法在不同人员书写的单例模式不尽相同，甚至单例调用的方法也有差别的情况下，代码走读、查找单例调用区域的时候需要按照多个调用方法查找，进而导致查找效率较低的问题发生。

技术实现思路

[0003]本专利技术提供了一种基于关键字检测的代码质量改进方法和系统，用以解决不同人员书写的单例模式不尽相同，甚至单例调用的方法也有差别，导致代码走读、查找单例调用区域的时候需要按照多个调用方法查找，进而导致查找效率较低的问题，所采取的技术方案如下：
[0004]一种基于关键字检测的代码质量改进方法，所述代码质量改进方法包括：
[0005]针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance；
[0006]制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范；
[0007]在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式。
[0008]进一步地，针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance，包括：
[0009]确定待改进的产品代码范围，并对所述产品代码范围进行代码区域划分，形成多个代码区域；
[0010]对所述代码区域对应代码部分进行提取，生成目标代码；
[0011]在所述目标代码中查找是否有使用单例模式；如果使用了单例模式，则查看所述单例模式的实现方式，确定关键字是否为instance；如果关键字不是instance，则对代码进行修改并替换成规定的关键字instance；
[0012]如果所述目标代码中没有使用单例模式，跳过该步骤；
[0013]重复以上步骤，直至所有目标代码完成扫描。
[0014]进一步地，制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范，包括：
[0015]制定一个统一的命名规范，其中，所述命名规范包括但不限制于变量、函数、类等命名的规则，例如变量采用小驼峰命名法、类采用大驼峰命名法等；
[0016]将制定的命名规范编写成文档，生成目标文档；
[0017]对产品代码进行全面的审查，识别出不符合制定的命名规范的代码；
[0018]对于不符合命名规范的代码进行修改，使其符合制定的规范；
[0019]将制定的命名规范加载到产品代码内，确保所有的开发人员都能使用统一的命名规范。
[0020]进一步地，在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式，包括：
[0021]将所述统一的命名规范通过消息公布方式发送至所有开发人员终端；
[0022]在开发工具中配置与所述统一的命名规范对应的提醒插件，其中所述提醒插件用于在代码编写过程中对不符合规范的命名方式进行自动提示；
[0023]对于已经存在的不符合规范的命名方式的代码，进行检查并提醒开发人员修改为规范的命名方式；
[0024]当超过预设的提醒周期后，仍存在不同的不符合规范的命名方式，则针对不同的不符合规范的命名方式进行批量修改；
[0025]定期对代码库进行检查，针对不符合规范的命名方式并进行修复，以保证代码库的整洁性和可维护性。
[0026]一种基于关键字检测的代码质量改进系统，所述代码质量改进系统包括：
[0027]产品代码扫描及确定模块，用于针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance；
[0028]统一制定模块，用于制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范；
[0029]开发监控及提醒模块，用于在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式。
[0030]进一步地，所述产品代码扫描及确定模块包括：
[0031]产品代码范围确定模块，用于确定待改进的产品代码范围，并对所述产品代码范围进行代码区域划分，形成多个代码区域；
[0032]目标代码生成模块，用于对所述代码区域对应代码部分进行提取，生成目标代码；
[0033]单例模式判断模块，用于在所述目标代码中查找是否有使用单例模式；如果使用了单例模式，则查看所述单例模式的实现方式，确定关键字是否为instance；如果关键字不是instance，则对代码进行修改并替换成规定的关键字instance；
[0034]步骤跳转模块，用于如果所述目标代码中没有使用单例模式，跳过该步骤；
[0035]循环执行模块，用于依次重复启动执行产品代码范围确定模块、目标代码生成模块、单例模式判断模块和步骤跳转模块，直至所有目标代码完成扫描。
[0036]进一步地，所述统一制定模块包括：
[0037]命名规范制定模块，用于制定一个统一的命名规范，其中，所述命名规范包括但不限制于变量、函数、类等命名的规则，例如变量采用小驼峰命名法、类采用大驼峰命名法等；
[0038]目标文档生成模块，用于将制定的命名规范编写成文档，生成目标文档；
[0039]代码审查识别模块，用于对产品代码进行全面的审查，识别出不符合制定的命名规范的代码；
[0040]代码修改模块，用于对于不符合命名规范的代码进行修改，使其符合制定的规范；
[0041]命名规范加载模块，用于将制定的命名规范加载到产品代码内，确保所有的开发人员都能使用统一的命名规范。
[0042]进一步地，所述开发监控及提醒模块包括：
[0043]命名规范发布模块，用于将所述统一的命名规范通过消息公布方式发送至所有开发人员终端；
[0044]提醒插件配置模块，用于在开发工具中配置与所述统一的命名规范对应的提醒插件，其中所述提醒插件用于在代码编写过程中对不符合规范的命名方式进行自动提示；
[0045]检查及提醒模块，用于对于已经存在的不符合规范的命名方式的代码进行检查并提醒开发人员修改为规范的命名方式；
[0046]批量修改模块，用于当超过预设的提醒周期后，仍存在不同的不符合规范的命名方式，则针对不同的不符合规范的命名方式进行批量修改；
[0047]定期检查及修复模块，用于定期对代码库进行检查，针对不符合规范的命名方式并进行修复，以保证代码库的整洁性和可维本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种基于关键字检测的代码质量改进方法，其特征在于，所述代码质量改进方法包括：针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance；制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范；在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式。2.根据权利要求1所述代码质量改进方法，其特征在于，针对待改进质量的产品代码进行扫描，并确定所述待改进质量的产品代码的单例模式的关键字instance，包括：确定待改进的产品代码范围，并对所述产品代码范围进行代码区域划分，形成多个代码区域；对所述代码区域对应代码部分进行提取，生成目标代码；在所述目标代码中查找是否有使用单例模式；如果使用了单例模式，则查看所述单例模式的实现方式，确定关键字是否为instance；如果关键字不是instance，则对代码进行修改并替换成规定的关键字instance；如果所述目标代码中没有使用单例模式，跳过该步骤；重复以上步骤，直至所有目标代码完成扫描。3.根据权利要求1所述代码质量改进方法，其特征在于，制定统一的命名规范，并将所述统一的命名规范加载运行到产品代码内，使所述产品代码统一使用该命名规范，包括：制定一个统一的命名规范；将制定的命名规范编写成文档，生成目标文档；对产品代码进行全面的审查，识别出不符合制定的命名规范的代码；对于不符合命名规范的代码进行修改，使其符合制定的规范；将制定的命名规范加载到产品代码内，确保所有的开发人员都能使用统一的命名规范。4.根据权利要求1所述代码质量改进方法，其特征在于，在开发过程中，当出现不符合规范的命名方式时，进行提示并要求开发人员使用规定格式，包括：将所述统一的命名规范通过消息公布方式发送至所有开发人员终端；在开发工具中配置与所述统一的命名规范对应的提醒插件，其中所述提醒插件用于在代码编写过程中对不符合规范的命名方式进行自动提示；对于已经存在的不符合规范的命名方式的代码，进行检查并提醒开发人员修改为规范的命名方式；当超过预设的提醒周期后，仍存在不同的不符合规范的命名方式，则针对不同的不符合规范的命名方式进行批量修改；定期对代码库进行检查，针对不符合规范的命名方式并进行修复。5.一种基于关键字检测的代码质量改进系统，其特征在于，所述代码质量改进系统包括：产品代码扫描及确定模块，用于针对待改进质量的产品代码进行...

【专利技术属性】
技术研发人员：兰雨晴，余丹，郑涵，王丹星，唐霆岳，
申请(专利权)人：慧之安信息技术股份有限公司，
类型：发明
国别省市：