软件注释的控制方法及装置制造方法及图纸

本发明专利技术公开了一种软件注释的控制方法及装置，其中方法包括：统计预定时间段内对软件的操作记录，其中，所述操作包括增加代码或／和注释、修改代码或／和注释，以及删除代码或／和注释；利用所述操作记录，计算出所述时间段内软件的总注释率；如果所述总注释率大于预置的总注释率阈值，则确定软件注释合格。采用本发明专利技术，可统计出更加准确的注释率。

【技术实现步骤摘要】

本专利技术涉及计算机软件编程
，尤其涉及一种软件注释的控制方法及装置。
技术介绍
在计算机软件编程中，软件注释是软件开发过程中的一个重要组成部分。在软件 开发过程中，程序开发人员经常变动，良好的软件注释使新参与或者新交替的程序员能够 快速理解原来的编程思路，迅速进入角色，提高编程效率。在编码过程中，除了每个函数和 文件给出注释说明外，要求对一些关键步骤以及比较难理解的语句都做出注释，在代码比 较稳定后的维护阶段，对每一个修改处都应该做出注释，此时的注释对于后续定位因为修 改而引入的新bug(程序中隐藏的错误、缺陷、漏洞或问题)是至关重要的。 目前，采用如下公式计算软件注释率 注释率=注释总行数/ (注释总行数+代码总行数)................公式1 如果通过公式1计算出来的注释率大于某个规定值，就认为注释率合格，否则认 为不合格。 然而，这种软件注释计算方式存在不准确的问题，具体分析如下 1、传统的注释率计算方法，对开发过程中的注释情况缺乏控制， 一般针对的是编 码阶段或者很长一段时间内总的注释情况进行计算，这可以从公式1看出，公式1中涉及的 是注释总行数和代码总行数， 一般都是指从开始编码到统计时刻为止的时间内的总的代码 注释情况，可能是1个月、2个月，甚至是1年内的注释情况，不能了解开发过程中每一次修改的注释情况，无法进行过程控制，甚至导致补注释的现象出现，所谓补注释，是指计算出 来的注释率低于阈值时，突击进行补救注释，即在质量管理部门进行注释检查前一天突击补注释，这样的注释往往质量低下，很难表征代码的真正含义。 2、对于维护或者增量开发软件，很多情况下不是新增加程序文件，而是在原程序 文件的基础上进行修改，这种开发模式一般遵循如下规则 对原来的稳定成熟的程序文件进行修改时，进行注释，不论是增加、修改还是删除 程序文件的内容，都应该注释。尤其对于成熟的代码，更是每次小的修改都应该注释，这些 注释常常是定位这次修改而引入bug的最重要的线索。 而传统的注释率计算公式(公式1)无法反映这种规则的要求，从计算结果中不能 判断是否遵循了上述规则。如果在一个程序文件中同时增加和删除代码，计算代码总行数 时，删除代码的代码行数会抵消增加代码的代码行数，例如，在一个文件中同时增加5行代 码并删除另外5行代码，同时不做任何注释，如果按照公式1的注释率计算方法，计算出来 的注释率将保持不变，这样虽然程序员违反了上述规则，但质量保证人员无法得知，也即无法进行监控了。
技术实现思路
有鉴于此，本专利技术要提供一种软件注释的控制方法及装置，以解决现有方案注释率计算不准确的问题，从而提高编程效率。 为此，本专利技术实施例采用如下技术方案 —种软件注释的控制方法，包括 统计预定时间段内对软件的操作记录，其中，所述操作包括增加代码或/和注释、修改代码或/和注释，以及删除代码或/和注释； 利用所述操作记录，计算出所述时间段内软件的总注释率； 如果所述总注释率大于预置的总注释率阈值，则确定软件注释合格。其中，所述利用操作记录计算出所述时间内软件的总注释率的具体过程为 确定所述时间段内增加注释行数和修改注释行数之和为第一和； 确定所述时间段内增加代码行数、删除代码行数、修改代码行数、增加注释行数以及修改注释行数之和为第二和； 确定所述总注释率为所述第一和与第二和之比。 其中，所述时间段内对软件的操作记录由至少两次软件更新中的操作记录构成； 所述方法还包括 利用每次软件更新的操作记录以及软件更新的次数，确定平均过程注释率； 当所述平均过程注释率大于预置的平均过程注释率阈值时，才确定软件注释合格。 其中，确定平均过程注释率的具体过程为 对于各次软件更新，利用其操作记录计算出该次软件更新的注释率； 利用每次软件更新的注释率以及软件更新次数，计算出平均过程注释率。 其中，所述时间段内对软件的操作记录由至少两次软件更新中的操作记录构成； 所述方法还包括 利用每次软件更新的操作记录、预置的单次更新注释率目标以及统计的软件更新 的次数，确定过程注释有效率； 当所述过程注释有效率大于预置的过程注释有效率阈值时，才确定软件注释合 格。 其中，确定过程注释有效率的具体过程为 对于各次软件更新，利用其操作记录计算出该次软件更新的注释率； 统计软件更新的注释率大于预置的单次更新注释率目标的软件更新次数，利用合格的软件更新次数占总的软件更新次数的比值，确定过程注释有效率。 其中，每次软件更新的注释率的计算过程为 确定该次软件更新中增加注释行数和修改注释行数之和为第三和； 确定该次软件更新中增加代码行数、删除代码行数、修改代码行数、增加注释行数以及修改注释行数之和为第四和； 确定该次软件更新的注释率为所述第三和与第四和之比。 优选地，上述方法还包括 当任一次软件更新的注释率为0时，确定软件注释不合格。 —种软件注释的控制装置，包括5 统计单元，用于统计预定时间段内对软件的操作记录，其中，所述操作包括增加代 码或/和注释、修改代码或/和注释，以及删除代码或/和注释； 总注释率计算单元，用于利用所述统计单元提供的操作记录，计算出所述时间段 内软件的总注释率； 控制单元，如果所述总注释率计算单元计算出的总注释率大于预置的总注释率阈 值，则确定软件注释合格。 其中，所述统计单元统计的操作记录由至少两次的软件更新的操作记录构成，所 述装置还包括 软件更新注释率计算单元，用于根据软件更新过程中的操作记录计算出该次软件 更新的注释率； 平均过程注释率计算单元，用于利用每次软件更新的注释率以及统计出的软件更 新次数，计算出平均过程注释率； 平均过程注释率判断单元，用于判断所述平均过程注释率是否大于预置的平均过 程注释率阈值，若是，指示所述控制单元确定软件注释合格，否则，指示所述控制单元确定 软件注释不合格。 其中，所述统计单元统计的操作记录由至少两次的软件更新的操作记录构成，所 述装置还包括 软件更新注释率计算单元，用于根据软件更新过程中的操作记录计算出该次软件 更新的注释率； 过程注释有效率计算单元，用于根据每次软件更新的注释率、预置的单次更新注 释率目标以及统计的软件更新次数，计算出过程注释有效率； 过程注释有效率判断单元，用于判断所述过程注释有效率是否大于预置的过程注释有效率阈值，若是，指示所述控制单元确定软件注释合格，否则，指示所述控制单元确定软件注释不合格。 优选地，该装置还包括 软件更新单次不合格确定单元，用于判断是否存在某次软件更新的注释率为0的 情况，若是，指示所述控制单元确定软件注释不合格。 对于上述技术方案的技术效果分析如下 1 :本专利技术实施例精确计算出增加代码行数、修改代码行数、删除代码行数、增加注 释行数、删除注释行数、修改注释行数，因此为基础计算总注释率(公式4)，避免了传统公 式(公式1)中同时删除代码和增加代码时注释率互相抵消的情况出现，使注释率更加准 确，从而提高编程效率。 2:通过引入平均过程注释率和过程注释有效率这两个指标，反映了某个开发阶段 (某段时间)中的平均的注释情况，用于保证每次软件更新过程中都需要适量的注释，杜绝 补注释的现象。 3 :通过计算每次软件更新操作的注释率，只要一次更新操本文档来自技高网...

【技术保护点】
一种软件注释的控制方法，其特征在于，包括：统计预定时间段内对软件的操作记录，其中，所述操作包括增加代码或／和注释、修改代码或／和注释，以及删除代码或／和注释；利用所述操作记录，计算出所述时间段内软件的总注释率；如果所述总注释率大于预置的总注释率阈值，则确定软件注释合格。

【技术特征摘要】

【专利技术属性】
技术研发人员：余再跃，
申请(专利权)人：大唐移动通信设备有限公司，
类型：发明
国别省市：11[中国|北京]