[發明專利]軟件注釋的控制方法及裝置

無效

• 申請號: 200910077295.1
• 申請日: 2009-01-21
• 公開（公告）號: CN101782849A
• 公開（公告）日: 2010-07-21
• 發明（設計）人: 余再躍
• 申請（專利權）人: 大唐移動通信設備有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京信遠達知識產權代理事務所(普通合伙) 11304
• 代理人: 王學強

技術領域

本發明涉及計算機軟件編程技術領域，尤其涉及一種軟件注釋的控制方法及裝置。

背景技術

在計算機軟件編程中，軟件注釋是軟件開發過程中的一個重要組成部分。在軟件開發過程中，程序開發人員經常變動，良好的軟件注釋使新參與或者新交替的程序員能夠快速理解原來的編程思路，迅速進入角色，提高編程效率。在編碼過程中，除了每個函數和文件給出注釋說明外，要求對一些關鍵步驟以及比較難理解的語句都做出注釋，在代碼比較穩定后的維護階段，對每一個修改處都應該做出注釋，此時的注釋對于后續定位因為修改而引入的新bug(程序中隱藏的錯誤、缺陷、漏洞或問題)是至關重要的。

目前，采用如下公式計算軟件注釋率：

注釋率＝注釋總行數/(注釋總行數+代碼總行數)................公式1

如果通過公式1計算出來的注釋率大于某個規定值，就認為注釋率合格，否則認為不合格。

然而，這種軟件注釋計算方式存在不準確的問題，具體分析如下：

1、傳統的注釋率計算方法，對開發過程中的注釋情況缺乏控制，一般針對的是編碼階段或者很長一段時間內總的注釋情況進行計算，這可以從公式1看出，公式1中涉及的是注釋總行數和代碼總行數，一般都是指從開始編碼到統計時刻為止的時間內的總的代碼注釋情況，可能是1個月、2個月，甚至是1年內的注釋情況，不能了解開發過程中每一次修改的注釋情況，無法進行過程控制，甚至導致補注釋的現象出現，所謂補注釋，是指計算出來的注釋率低于閾值時，突擊進行補救注釋，即在質量管理部門進行注釋檢查前一天突擊補注釋，這樣的注釋往往質量低下，很難表征代碼的真正含義。

2、對于維護或者增量開發軟件，很多情況下不是新增加程序文件，而是在原程序文件的基礎上進行修改，這種開發模式一般遵循如下規則：

對原來的穩定成熟的程序文件進行修改時，進行注釋，不論是增加、修改還是刪除程序文件的內容，都應該注釋。尤其對于成熟的代碼，更是每次小的修改都應該注釋，這些注釋常常是定位這次修改而引入bug的最重要的線索。

而傳統的注釋率計算公式(公式1)無法反映這種規則的要求，從計算結果中不能判斷是否遵循了上述規則。如果在一個程序文件中同時增加和刪除代碼，計算代碼總行數時，刪除代碼的代碼行數會抵消增加代碼的代碼行數，例如，在一個文件中同時增加5行代碼并刪除另外5行代碼，同時不做任何注釋，如果按照公式1的注釋率計算方法，計算出來的注釋率將保持不變，這樣雖然程序員違反了上述規則，但質量保證人員無法得知，也即無法進行監控了。

發明內容

有鑒于此，本發明要提供一種軟件注釋的控制方法及裝置，以解決現有方案注釋率計算不準確的問題，從而提高編程效率。

為此，本發明實施例采用如下技術方案：

一種軟件注釋的控制方法，包括：

統計預定時間段內對軟件的操作記錄，其中，所述操作包括增加代碼或/和注釋、修改代碼或/和注釋，以及刪除代碼或/和注釋；

利用所述操作記錄，計算出所述時間段內軟件的總注釋率；

如果所述總注釋率大于預置的總注釋率閾值，則確定軟件注釋合格。

其中，所述利用操作記錄計算出所述時間內軟件的總注釋率的具體過程為：

確定所述時間段內增加注釋行數和修改注釋行數之和為第一和；

確定所述時間段內增加代碼行數、刪除代碼行數、修改代碼行數、增加注釋行數以及修改注釋行數之和為第二和；

確定所述總注釋率為所述第一和與第二和之比。

其中，所述時間段內對軟件的操作記錄由至少兩次軟件更新中的操作記錄構成；

所述方法還包括：

利用每次軟件更新的操作記錄以及軟件更新的次數，確定平均過程注釋率；

當所述平均過程注釋率大于預置的平均過程注釋率閾值時，才確定軟件注釋合格。

其中，確定平均過程注釋率的具體過程為：

對于各次軟件更新，利用其操作記錄計算出該次軟件更新的注釋率；

利用每次軟件更新的注釋率以及軟件更新次數，計算出平均過程注釋率。

其中，所述時間段內對軟件的操作記錄由至少兩次軟件更新中的操作記錄構成；

所述方法還包括：

利用每次軟件更新的操作記錄、預置的單次更新注釋率目標以及統計的軟件更新的次數，確定過程注釋有效率；

當所述過程注釋有效率大于預置的過程注釋有效率閾值時，才確定軟件注釋合格。

其中，確定過程注釋有效率的具體過程為：

對于各次軟件更新，利用其操作記錄計算出該次軟件更新的注釋率；