[发明专利]一种面向对象程序的注释质量评价和注释建议方法

摘要

本发明公开了软件工程领域内的一种面向对象程序的注释质量评价和注释建议方法，包括以下步骤1）遍历目标代码文件，提取代码文件中主类的注释和其所注释的类名、方法的注释和其所注释的方法名，步骤2‑1）根据关于主类注释的分析规则对主类文件中的注释部分与类名进行质量分析，并对不满足分析规则的注释给出相应的建议；步骤2‑2）根据关于方法注释的分析规则对方法文件中的注释部分与方法名进行质量分析，并对不满足分析规则的注释给出相应的建议；步骤3）根据上述的建议的数量来给出整体的质量评价，本发明根据所计算的结果给出关于头注释和方法注释的建议，提高代码注释的质量，有利于对软件代码质量的完善，可用于软件的维护开发中。

主权项

一种面向对象程序的注释质量评价和注释建议方法，其特征在于，包括以下步骤：步骤1)遍历目标代码文件，提取代码文件中主类的注释和其所注释的类名、方法的注释和其所注释的方法名，将主类的注释和其所注释的类名存入主类文件内，将方法的注释和其所注释的方法名存入方法文件内；步骤2‑1)：根据关于主类注释的分析规则对主类文件中的注释部分与类名进行质量分析，并对不满足分析规则的注释给出相应的建议，所述步骤2‑1)的质量分析方法如下：a)遍历主类文件中的注释部分，检索该注释部分是否存在“作者”，如果不存在，则给出添加作者的建议；b)查看该注释部分是否存在对主类的描述，如果不存在，则给出添加描述的建议，如果存在对主类的描述，则分析其相关性；c)分析相关性，利用公式L＝N/M*100％计算出注释与主类的相关性，其中M表示对类名进行骆驼式命名法后分割出的单词总数，N表示注释中与类名相关的单词的个数，并将L与预先设定的门槛值比较，如果大于门槛值，说明相关性较高，如果低于门槛值，说明相关性较低，并且给出添加更多描述的建议；步骤2‑2)：根据关于方法注释的分析规则对方法文件中的注释部分与方法名进行质量分析，并对不满足分析规则的注释给出相应的建议；步骤3)：根据上述的建议的数量来给出整体的质量评价。