[发明专利]代码注释检测方法及装置

说明书

本公开提供一种代码注释检测方法及装置，所述方法包括基于预先安装并配置完成的代码注释检测工具，获取目标代码文件的扫描信息；根据所述扫描信息，判断所述扫描信息中是否存在预设的注释符号，若存在所述预设的注释符号，则判断与所述注释符号对应的注释信息是否符合预设注释规则，若所述注释信息不符合预设注释规则，则进行报错，并且给出提示文件。本公开的代码注释检测方法能够保证每个代码文件均有对应的注释，并且是符合要求的注释，可以有效地帮助编程人员理解代码的含义和规则，减少编程人员之间的沟通成本，有效提高工作效率。

技术领域

本公开涉及检测技术领域，尤其涉及一种代码注释检测方法及装置。

背景技术

很多技术人员不习惯对代码进行注释,导致代码的可读性很差,很多人的英语水平层次不齐,或者有些人干脆用拼音定义方法名称,这都导致代码的可读性非常差。

对于有些人来说,会使用文档注释,另外一些人却喜欢单行注释的方式，最后的结果就是代码标准化比较差。有些人用他自己的方式写一段逻辑,另外一些人却习惯另外一种逻辑写代码,然而都没有写注释,其他人看这段代码就会云里雾里。

公开于本申请背景技术部分的信息仅仅旨在加深对本申请的一般背景技术的理解，而不应当被视为承认或以任何形式暗示该信息构成已为本领域技术人员所公知的现有技术。

发明内容

本公开实施例提供一种代码注释检测方法及装置，能够保证每个代码文件均有对应的注释，并且是符合要求的注释，可以有效地帮助编程人员理解代码的含义和规则，减少编程人员之间的沟通成本，有效提高工作效率。

本公开实施例的第一方面，提供一种方法代码注释检测方法，包括：

基于预先安装并配置完成的代码注释检测工具，获取目标代码文件的扫描信息；

根据所述扫描信息，判断所述扫描信息中是否存在预设的注释符号，

若存在所述预设的注释符号，则判断与所述注释符号对应的注释信息是否符合预设注释规则，

若所述注释信息不符合预设注释规则，则进行报错，并且给出提示文件。

在一种可选的实施方式中，

所述预设的注释符号包括“/*”或“//”，

在判断与所述注释符号对应的注释信息是否符合预设注释规则之前，所述方法还包括：

获取与所述预设的注释符号对应的注释信息。

在一种可选的实施方式中，

所述判断与所述注释符号对应的注释信息是否符合预设注释规则的方法包括：

获取所述注释符号对应的注释信息的字符数量，判断所述字符数量是否满足预设注释规则；

若所述字符数量小于预设阈值，则判定所述注释符号对应的注释信息不符合预设注释规则。

在一种可选的实施方式中，

所述判断与所述注释符号对应的注释信息是否符合预设注释规则的方法还包括：

获取所述注释符号对应的注释信息的语言类型，判断所述语言类型是否满足预设语言规则；

若所述语言类型不满足预设语言规则，则判定所述注释符号对应的注释信息不符合预设注释规则。

在一种可选的实施方式中，

所述代码注释检测工具包括NodeJS管理工具。

本公开实施例的第二方面，提供一种代码注释检测装置，包括：