[发明专利]Python语言项目的注释信息占比分析方法、装置及电子设备

说明书

本发明公开了一种Python语言项目的注释信息占比分析方法，所述方法包括：获取待解析Python文件的源代码，通过词法解析器将所述待解析Python文件的源代码进行分解获取代码元素；遍历所述代码元素获取注释元素，其中，所述注释元素包括第一注释元素和第二注释元素，所述第一注释元素为“#”元素，所述第二注释元素为字符串元素；提取所述第一注释元素对应的第一文本，基于预设规则对第二注释元素进行提取后获取对应的第一字符串；统计所述待解析Python文件的源代码的总行数和空白行数，统计所述第一文本、所述第一字符串的总行数作为注释内容总行数；基于所述待解析Python文件的源代码的总行数和空白行数、所述注释内容总行数确定所述待解析Python文件的源代码的注释占比。

技术领域

本申请涉及软件开发领域，尤其涉及一种Python语言项目的注释信息占比分析方法、装置及电子设备。

背景技术

在软件开发领域中，为了保证项目开发的效率，以及所开发的软件产品在整个生命周期中的健康，软件产品的可维护性以及代码的可读性一直是软件开发领域中的重中之重。为了提高软件产品的可读性及可维护性，行业内多使用前期指定详细的开发文档、开发中指定严格的开发守则、对代码的测试覆盖率进行严格要求等方案。

这些规则从各个方面对软件的开发者的行为进行约束，有效提高了软件开发领域的整体产出水平。如由阿里巴巴推出的《阿里巴巴Java开发手册》，从变量的命名规范、代码格式风格、面向对象编程范式、控制语句的使用、项目工程结构、第三方依赖管理、数据库操作、单元测试等多个方面对开发人员进行约束。确保软件开发者之间实现达成共识，编写理解成本更低的代码，进而提高效率和代码可读性，进而提高产品的可维护性。创造更多价值。

在件开发代码质量管理方面，不同的编程语言往往使用不同的工具。Python编程语言生态中，有coverage这样的开源工具用于检测代码的测试覆盖率，也有pylint这样基于规模庞大的扣分规则，为代码质量评分的开源工具。

虽然有了很多工具用于控制代码质量，但是软件开发中，编程语言至始至终都是一种面向机器的语言，其本质决定了人类在阅读代码时，不可能做到机器一样的高效。这时代码中的注释部分就成为了帮助人类对理解代码的关键。

注释是一种特殊的代码，软件在运行中会跳过执行注释部分，注释的功能是代码编写者传递信息给代码的阅读者和维护者，用于辅助他人理解自己的工作，进而高效的合作。在软件开发中，越是复杂的业务，就越是需要充分的注释，代码中注释所占的比例，能在一定程度上衡量软件代码的质量。

由于注释本身不参与程序的运行，编写注释的收益属于长期收益，无法立刻体现出其巨大的价值。同时因为其不参与程序运行的特性，在大型项目中，可以轻易编写大量无价值的注释，降低了注释占比这一指标的价值。项目管理者和软件开发者或无法意识到其重要性，或者出于短期成本考虑，不强制要求代码中注释的比例。

但是不能否认的是，对代码中注释占比进行一定的约束，可以有效地提高代码的可维护性。如果项目管理者想要对其进行约束时，只能人工统计或者凭借直觉评价，无疑会造成人力资源的浪费，甚至抵消这一约束的价值。

因此，亟需一个可靠、准确、专业的方法和装置，解决这一问题。

发明内容

本申请实施例要解决的技术问题，在于提供一种Python语言项目的注释信息占比分析方法、装置及电子设备，以解决现有Python项目中缺少快速的统计注释占比的工具的技术问题。

为实现上述目的，本申请实施例采用下述技术方案：

第一方面，本申请实施例提供一种Python语言项目的注释信息占比分析方法，所述方法包括：

获取待解析Python文件的源代码，通过词法解析器将所述待解析Python文件的源代码进行分解获取代码元素；