[发明专利]代码可读性检查方法、装置以及服务器

说明书

本发明公开了一种代码可读性检查方法，该方法包括：接收用户的代码可读性检查请求后获取所述代码的源代码信息；然后根据预设的格式规范对所述源代码信息进行检查，标记并记录不规范代码的位置和次数；接着再标记出所述源代码信息中包括声明变量和循环函数体的特定代码元素进行跟踪和试运行，然后记录试运行过程中出现错误的不规范特定代码元素的位置和次数；最后输出代码可读性检查报告。本发明还提供一种代码可读性检查装置、服务器以及计算机可读存储介质。本发明提供的代码可读性检查方法、装置、服务器及计算机可读存储介质可以更深层次对所述源代码信息中的格式和特定代码元素的使用进行检查，从而能够更精确而有效地检查出不规范之处。

技术领域

本发明涉及代码可读性检查技术领域，尤其涉及一种代码可读性检查方法、装置、服务器及计算机可读存储介质。

背景技术

对于任一开发平台或者企业，对于代码开发一般都有至少一个代码规范，代码规范中包含对于代码编写的风格和规则要求。但是，对于每个研发人员，都有自己的编写习惯，所以会经常导致编写出的代码质量不符合所属项目代码规范的要求；另外，对于研发经验不足的研发人员也容易编写出的代码质量不符合所属项目代码规范的要求；这样，就可能导致程序不能成功运行。

现有技术，会为开发人员提供代码质量的检测工具，以便开发人员在编写代码时，检测自己编写的代码质量是否符合所属项目的代码规范要求。但是大部分检测工具都只是简单检查代码的格式，而不会对代码的逻辑或者执行效果进行检查，因此，检查的效果很不准确。

发明内容

有鉴于此，本发明提出一种用户代码可读性检查方法、装置、计算机设备及计算机可读存储介质，能够接收用户的代码可读性检查请求后获取所述代码的源代码信息；然后根据预设的格式规范对所述源代码信息进行检查，标记并记录不规范代码的位置和次数；接着再标记出所述源代码信息中包括声明变量和循环函数体的特定代码元素进行跟踪和试运行，然后记录试运行过程中出现错误的不规范特定代码元素的位置和次数；最后输出代码可读性检查报告。因此，可以更深层次对所述源代码信息中的格式和特定代码元素的使用进行检查，从而能够更精确而有效地检查出不规范之处。

首先，为实现上述目的，本发明提供一种代码可读性检查方法，所述方法包括步骤：

接收用户的代码可读性检查请求，获取所述代码的源代码信息；根据预设的格式规范对所述源代码信息进行检查，对不符合所述格式规范的不规范源代码进行标记，并记录所述不规范代码的位置和次数；标记出所述源代码信息中的特定代码元素，并对所述特定代码元素进行跟踪和试运行，其中，所述特定代码元素包括声明变量和循环函数体；记录试运行过程中出现错误的不规范特定代码元素的位置和次数；输出代码可读性检查报告。

可选地，所述格式规范包括：命名格式规范和代码排版格式规范，其中，代码排版格式包括：空行、缩进、注释和重复代码；所述“根据预设的格式规范对所述源代码信息进行检查”的步骤包括：通过文本比对的方式判断所述源代码信息的名称是否符合命名规范，判断所述源代码信息中的空行、缩进、注释和重复代码是否符合格式规范。

可选地，所述“记录试运行过程中出现错误的不规范特定代码元素的位置和次数”步骤包括：通过文本比对方式找出所述特定代码元素；以及：对最先查找到的声明变量标记为初始声明变量，然后每次查找到所述声明变量时，则对出现所述声明变量的代码段进行试运行，判断所述声明变量是否能调用到初始声明变量，调用到初始声明变量时则判断所述声明变量为出现错误的声明变量；对于查找出的循环函数的代码段进行试运行，判断所述循环函数运行的时间是否超过预设的时间阈值，超过所述时间阈值时则判断所述循环函数为出现错误的循环函数。

可选地，所述“输出代码可读性检查报告”的步骤包括：据出所述不规范代码和所述不规范特定代码元素出现的次数分别对所述代码进行量化评分；然后对于量化评分低于预设的分值阈值时，在所述代码可读性检查报告中标记为代码可读性差。