白 楊，張麗萍

內(nèi)蒙古師范大學(xué) 計算機科學(xué)技術(shù)學(xué)院，呼和浩特 010022

1 引言

代碼注釋是軟件開發(fā)的一個重要組成部分，能夠輔助編程人員有效地理解源代碼。代碼注釋一般用自然語言的形式闡述代碼背后實現(xiàn)的邏輯或功能[1]，開發(fā)人員依賴代碼注釋了解源代碼描述的功能。在規(guī)范的軟件開發(fā)過程中，編程人員會被要求在源代碼的適當(dāng)位置添加適量的代碼注釋[2]。

在實際中，缺乏代碼注釋是軟件工程領(lǐng)域中的常見問題，大多數(shù)軟件代碼注釋較少，大部分程序員只注重所編寫的代碼，而忽略與代碼相對應(yīng)的注釋或者文檔，這就導(dǎo)致程序的可讀性和可維護(hù)性大大降低，同時降低開發(fā)效率。再者，如果程序員在編寫代碼的同時手動書寫代碼注釋或者文檔，既浪費程序員的時間，又使得工作效率降低。因此，自動生成代碼注釋是必要的，它不僅可以節(jié)省開發(fā)人員編寫注釋的時間，提高工作效率，而且程序可讀性和可維護(hù)性也會大大提升。

本文通過檢測原項目軟件和目標(biāo)軟件的相似性代碼，對提取的代碼和注釋進(jìn)行精簡優(yōu)化處理，最終為目標(biāo)軟件自動生成代碼注釋。

2 相關(guān)工作及概念

2.1 代碼注釋的概念及類型

代碼注釋即對代碼的解釋和說明，主要是為了讓開發(fā)者迅速理解代碼，是程序員為語句、程序段、函數(shù)等給出的解釋或提示，能提高程序代碼的可讀性。換句話說，代碼注釋就是用自然語言的形式闡述代碼背后實現(xiàn)的邏輯或功能，是描述軟件功能的可讀性自然語言，是架起程序設(shè)計者與開發(fā)者之間的通信橋梁，與此同時能夠提高團(tuán)隊開發(fā)合作效率，因此，自動生成代碼注釋在整個注釋的研究中是至關(guān)重要的。

代碼注釋按照注釋對象可以分成三種類型[3]，即文檔注釋（Javadoc/Document Comment）、塊注釋（Block Comment）和行注釋（Line Comment）。為了直觀說明，圖1給出了三種代碼注釋類型的例子。其中，文檔注釋包括類注釋、方法注釋、屬性注釋、包注釋和概要注釋，一般以/**...注釋內(nèi)容...*/或者@...的形式表示；塊注釋分隔源代碼區(qū)域，該區(qū)域可以跨越多行或單行的一部分，使用起始分隔符和結(jié)束分隔符指定此區(qū)域，通常以/*...注釋內(nèi)容...*/的形式表示；行注釋是指以注釋分隔符開始并一直持續(xù)到行的結(jié)尾，或者在某些情況下，從源代碼中特定列（字符行偏移）開始，并繼續(xù)直到行的結(jié)尾，簡單地說，行注釋是指跟在代碼行后面，描述當(dāng)前代碼所表達(dá)的功能，例如Java 語言中，單行注釋以“//”開頭，跟在“//”后面的文本就是注釋內(nèi)容。其中文檔注釋可以由工具自動生成[4-5]，而塊注釋和行注釋則需要由編程人員手動添加。

2.2 國內(nèi)外研究現(xiàn)狀

對于代碼注釋自動生成國內(nèi)外均有一定的研究基礎(chǔ)，Wong等人提出了一種從StackOverflow上挖掘大規(guī)模問答數(shù)據(jù)來自動生成代碼注釋的方法[6]。該方法計算目標(biāo)軟件代碼和StackOverflow上的代碼片段之間的相似性，并將StackOverflow 上的代碼片段的描述用于生成目標(biāo)軟件代碼段的注釋。該方法雖然生成相應(yīng)的代碼注釋，但只能自動生成有限數(shù)量的注釋。

在此方法的基礎(chǔ)上，Wong 等人又提出了另一種通過挖掘現(xiàn)有軟件代碼庫來自動生成代碼注釋的方法[7]。該方法使用代碼克隆檢測技術(shù)從軟件代碼庫中發(fā)現(xiàn)語法相似的代碼片段，并將代碼注釋應(yīng)用于其他語法類似的代碼片段上。該方法雖然可以產(chǎn)生良好且可提交的注釋，但自動生成注釋的產(chǎn)量和精度相對較低。

Sridhara等人提出了一種對Java方法生成注釋的方法[4]。該方法給定一個方法名和方法體，在自動生成注釋的同時描述該方法的功能。Sridhara等人還使用啟發(fā)式算法對Java方法的參數(shù)自動生成注釋[5]。這些方法雖然可以直接從代碼元素中合成自然語言的句子，但過度依賴于程序中的標(biāo)識符名稱和方法名。

Moreno 等人對Java 類生成注釋[8]。該方法根據(jù)一組啟發(fā)式方法，并使用現(xiàn)有的文本生成工具編寫注釋。生成的注釋主要描述了類本身涵蓋的內(nèi)容以及該類的功能。雖然該方法是第一種自動生成類的自然語言摘要的技術(shù)，但其質(zhì)量還需提高。

McBurney 和 McMillan 也提出了一種對 Java 方法生成注釋的辦法[9]。該方法總結(jié)了上下文，而不是方法內(nèi)部的細(xì)節(jié)。該方法使用PageRank在該上下文中找到最重要的方法，并使用SWUM（Software Word Usage Model）來收集描述這些方法行為的關(guān)鍵字。同時設(shè)計了一個自定義NLG（Natural Language Generation）系統(tǒng)來創(chuàng)建關(guān)于此上下文的自然語言文本。該方法雖然生成注釋的質(zhì)量優(yōu)越，但評估方法單一，影響結(jié)果。

綜上所述，在代碼注釋自動生成方面，大多數(shù)對代碼注釋的研究都存在注釋稀少、準(zhǔn)確度不高的問題，而且程序理解本身就存在一定的難度，因此本文針對這一問題，使用注釋復(fù)用的方法來提高代碼注釋的產(chǎn)量和質(zhì)量。

2.3 注釋復(fù)用及克隆檢測

研究者試圖利用人工及自動化的方法為代碼添加注釋，其中自動化方法主要包括注釋復(fù)用及注釋抽取[4-5，8]。本文使用了注釋復(fù)用的方法，從已有軟件項目和目標(biāo)軟件項目中找出相似代碼，將已有項目中的注釋信息處理后映射到目標(biāo)項目中的相似代碼段上。因此，找出相似代碼是其中的關(guān)鍵步驟，本文使用克隆檢測加以解決。在克隆研究領(lǐng)域，人們普遍將相同或相似的代碼段叫作克隆代碼，簡稱克隆[10]。現(xiàn)在比較權(quán)威的說法，克隆代碼可以被分為Type-1、Type-2、Type-3和Type-4四類[11]。克隆檢測指的是查找并反饋軟件系統(tǒng)中的克隆代碼，為軟件開發(fā)、維護(hù)、軟件重構(gòu)和演化等活動提供最基本的參考信息。

圖1 代碼注釋類型示例

國內(nèi)外關(guān)于克隆檢測方法和技術(shù)的研究已經(jīng)相對成熟。很多研究者對克隆檢測進(jìn)行了實驗，Roy等人開發(fā)的Nicad應(yīng)用靈活的過濾和規(guī)范化機制對文本檢測進(jìn)行改進(jìn)[12]，可有效檢測Type-1、Type-2以及Type-3克隆。

Kamiya等人開發(fā)了一款名為CCFinder的克隆檢測工具[13]。此工具將每一行代碼單獨轉(zhuǎn)化為Token 序列，然后合并所有的Token序列，這樣做是因為即使變量名和代碼結(jié)構(gòu)發(fā)生變化，也不會影響檢測結(jié)果。

Gabel等人將PDG（Program Dependence Graph）中的子圖同構(gòu)問題規(guī)約為子樹同構(gòu)問題[14]，再利用Deckard進(jìn)行檢測，來提高檢測的速度和可擴展性。

本團(tuán)隊在克隆檢測方面也進(jìn)行了大量研究。史慶慶等人使用優(yōu)化后綴數(shù)組的方法進(jìn)行克隆代碼檢測[15]，并實現(xiàn)了一款檢測軟件源代碼中克隆群的工具FCD（Function Clone Detector）；張久杰等人實現(xiàn)了基于Token編輯距離的檢測方法[16]，能有效檢測Type-3 克隆代碼。這些為本文的后續(xù)研究奠定了基礎(chǔ)。

3 代碼注釋自動生成

3.1 研究框架

本文自動生成代碼注釋分為四個階段：（1）克隆檢測階段；（2）代碼和注釋提取階段；（3）克隆代碼和注釋優(yōu)化精簡階段；（4）代碼與注釋映射階段。圖2 顯示了自動生成代碼注釋的步驟。

圖2 總體研究路線

本文提出的代碼注釋自動生成的方法，需要提供兩個輸入：（1）原項目軟件，擁有數(shù)量豐富、質(zhì)量較高的代碼注釋，可以從中提取規(guī)范的代碼注釋信息，本文從Github下載開源項目。（2）目標(biāo)項目軟件，通過該方法為其添加代碼注釋的項目軟件，即從原項目軟件中提取注釋信息，經(jīng)過精簡優(yōu)化映射到目標(biāo)項目軟件中相應(yīng)的代碼段上，本方法的輸出則是為目標(biāo)項目自動生成的代碼注釋文檔。

3.2 克隆代碼檢測

自動生成代碼注釋之前需要檢測克隆代碼，即原項目軟件與目標(biāo)軟件的相似代碼片段。檢測軟件中的克隆代碼是提取代碼和注釋的基礎(chǔ)，因此精準(zhǔn)的克隆檢測是自動生成代碼注釋的關(guān)鍵步驟。本文使用當(dāng)前領(lǐng)域較成熟的克隆檢測工具Nicad 進(jìn)行克隆檢測。Nicad 是基于文本的克隆檢測工具，可以較準(zhǔn)確地檢測出Type-1、Type-2、Type-3的克隆代碼。此工具可以檢測軟件內(nèi)部的克隆代碼，也可以檢測跨版本軟件的克隆代碼，為本文后續(xù)代碼注釋的研究提供更加準(zhǔn)確的數(shù)據(jù)來源。

本文在原項目軟件和目標(biāo)軟件之間找到相似的代碼段。從GitHub上下載了100個開源項目軟件，這些開源項目軟件的代碼注釋是由開發(fā)人員編寫。原項目的代碼注釋是經(jīng)過軟件演化過程最終沉淀形成的，相對完善成熟，質(zhì)量高并且規(guī)范化，極具參考價值，因此可以選取其作為標(biāo)準(zhǔn)集。本文將100款原項目軟件和5款目標(biāo)軟件作為輸入，利用Nicad 檢測這些原項目軟件和5 款目標(biāo)軟件，檢測結(jié)果以克隆對和克隆群的形式反饋。本文只采用克隆群形式的檢測結(jié)果，檢測結(jié)果存儲到XML（Extensible Markup Language）文件中。下面以FreeMind為例，介紹克隆檢測結(jié)果。圖3呈現(xiàn)了以克隆群形式反饋的部分內(nèi)容檢測結(jié)果。該XML顯示了檢測到的克隆代碼的相似度、文件路徑和文件名等詳細(xì)信息。

圖3 克隆檢測結(jié)果存儲方式

3.3 克隆代碼及其注釋的提取

通過克隆檢測結(jié)果只得到了這些克隆代碼的存儲路徑，在獲取克隆檢測結(jié)果之后，需要對克隆代碼和注釋進(jìn)行提取。自動生成代碼注釋是以提取的克隆代碼和注釋為線索映射成的集合，因此這一步驟是后續(xù)研究的基礎(chǔ)。

3.3.1 克隆代碼的提取

在克隆代碼提取階段，從克隆檢測階段獲取的XML 文件中，得知有文件名、文件路徑等信息，本文使用字符流讀取XML 文件，通過文件路徑和行號讀取文件，然后創(chuàng)建一個可以往文件中寫入字符數(shù)據(jù)的字符輸出流對象以便存儲數(shù)據(jù)。寫入數(shù)據(jù)時，首先判斷文件是否存在，如果文件不存在，則自動創(chuàng)建，如果文件存在，則會被覆蓋。然后將在指定行內(nèi)文件與不在指定行內(nèi)文件區(qū)分，存儲在兩個緩沖區(qū)中。最后獲取指定行內(nèi)文件的內(nèi)容寫入文件中，完成克隆代碼的提取。具體實現(xiàn)方法如下。

算法1 克隆代碼提取算法

輸入：克隆檢測XML文件。

輸出：克隆代碼提取文件。

1. def getdata（path，filename）

2. file1，buffer #定義生成的文件

3. For length in data do

4. buffer=read data

5. End For

6. If file1 no exist then

7. create file1

8. Else cover file1

9. write content

10. End If

3.3.2 代碼注釋的提取

在代碼注釋提取階段，需要提取出克隆代碼相對應(yīng)的注釋，通過XML文件提供的信息，獲取文件ID號、文件名、文件路徑、源文件起始行和結(jié)束行等信息。首先獲取克隆代碼，在得到克隆代碼文件以后，將克隆代碼文件解析成AST（Abstract Syntax Tree），然后從數(shù)據(jù)庫克隆代碼段的AST中檢索代碼注釋，最后將提取的代碼注釋存儲到文本文檔中。具體的代碼注釋提取算法如下。

算法2 代碼注釋提取算法

輸入：XMLpath。

輸出：克隆代碼、注釋內(nèi)容文檔。

1. def getXMLdata（xmlpath）

2. ElementTree 將XML文件解析為元素樹

3. List 獲取ElementTree根節(jié)點

4. content 注釋內(nèi)容

5. tar_file 獲取注釋行

6. For Clone Group in List do

7. If element.getName equals“clones”then

8. Return id，clones，sourcecode，startline，endline

9. End If

10. End For

11. While content

12. If linenumber in tar_file then

13. Return content

14. End If

提取的克隆代碼和注釋如圖4所示，圖中提取出的fireTreeNodesChanged（）表示提取的以方法為粒度的克隆代碼，/**…*/和//后面表示此克隆代碼相應(yīng)的注釋。

圖4 提取文檔部分示例

3.4 代碼及注釋精簡優(yōu)化

提取出所要的克隆代碼和代碼注釋后，不能直接將這些注釋映射到目標(biāo)文件的代碼，需要對提取的克隆代碼和注釋進(jìn)行精簡優(yōu)化，提高實驗結(jié)果的質(zhì)量和準(zhǔn)確度。因此對代碼和注釋的優(yōu)化是自動生成代碼注釋的關(guān)鍵步驟之一，此步驟直接影響最后的注釋質(zhì)量。這一階段分為兩個步驟：（1）克隆代碼精簡；（2）代碼注釋優(yōu)化。

3.4.1 克隆代碼精簡

代碼中包含許多的無用詞，這些詞對后續(xù)代碼與注釋映射的研究作用較小，而且無用詞的出現(xiàn)會對實驗結(jié)果的準(zhǔn)確度產(chǎn)生噪音，因此需對這些詞進(jìn)行處理。提取出克隆代碼以后，并不是每一段代碼都適合為其添加注釋，有的克隆代碼對于研究沒有很重要或者是必然的意義，克隆代碼檢測工具有時無法區(qū)分有意義匹配和無意義匹配，因此需要根據(jù)研究的實際情況來篩選出有意義的克隆代碼。本文采用兩條啟發(fā)式規(guī)則過濾各類型的停用詞，具體內(nèi)容如表1所示。

表1 停用詞規(guī)則表

3.4.2 代碼注釋優(yōu)化

原項目軟件中提取的代碼注釋與目標(biāo)軟件中代碼所描述或者表達(dá)的意思或功能不一定一致，亦或者表達(dá)太過冗余，這樣就會大大降低軟件代碼的可讀性和可維護(hù)性，同時浪費讀者的時間。在進(jìn)行代碼與注釋匹配之前，首先預(yù)處理所有提取的代碼注釋，去除無關(guān)項以及與代碼所表達(dá)的功能或含義不太相符的字符，然后對這些注釋進(jìn)行優(yōu)化，這樣可以使注釋變得更加淺顯易懂，開發(fā)者可以快速地理解此部分代碼所要表達(dá)的含義，提高其效率。因此，對于提取出的代碼注釋，本文通過三條啟發(fā)式規(guī)則對提取出的注釋進(jìn)行了精簡優(yōu)化，如表2所示。

表2 優(yōu)化注釋規(guī)則

3.5 代碼與注釋映射

提取的克隆代碼和代碼注釋經(jīng)過精簡優(yōu)化處理后，得到了相對較高的用于實驗研究的結(jié)果，此時，本文將優(yōu)化的代碼注釋映射到目標(biāo)軟件的代碼，即將目標(biāo)代碼提取出來，和原項目軟件提取優(yōu)化的注釋進(jìn)行匹配，將注釋映射到目標(biāo)軟件的代碼段上。通過Nicad配置文件的行號過濾，如果是這些行號內(nèi)的代碼，加上源文件提取出的對應(yīng)的注釋，為每一個方法和語句添加對應(yīng)的注釋，重新生成目標(biāo)軟件；如果不是這些行號內(nèi)的代碼，則直接寫入文件。其對應(yīng)的代碼注釋映射算法如下。

算法3 代碼與注釋映射算法

輸入：優(yōu)化后的XML文件和生成的注釋文件。

輸出：新的帶有注釋的代碼目標(biāo)文件。

1. def writeFileContent（filepath，newstr）

2. Temp

3. If file exists then

4. filein=newstr+" "；#新寫入的行，換行

5. End If

6. For temp=br.readline（）!=null do

7. Buffer.append（temp）

8. End For

3.6 生成代碼注釋

目標(biāo)軟件的代碼與原項目軟件的代碼進(jìn)行克隆檢測，找到二者相似的代碼，本文將克隆檢測出的代碼進(jìn)行精簡處理，然后從原項目軟件中提取代碼注釋，利用4個啟發(fā)式算法對提取的代碼注釋進(jìn)行優(yōu)化處理，最后將優(yōu)化后的注釋映射到目標(biāo)軟件的代碼上，此時代碼注釋自動生成已經(jīng)基本完成。本文最后自動生成的注釋和代碼的映射生成一個Java文件，其詳細(xì)內(nèi)容如圖5所示。

圖5 代碼注釋生成結(jié)果圖

4 實驗結(jié)果與分析

目標(biāo)軟件的注釋比較稀少且質(zhì)量不高，因此本文通過克隆檢測找出原項目軟件和目標(biāo)軟件的克隆代碼，對提取的代碼和注釋精簡優(yōu)化，得到質(zhì)量較高、數(shù)量適合的代碼注釋。本文為5 款目標(biāo)軟件經(jīng)過克隆檢測得到的55個代碼段生成了總共75條注釋。顯示了每個項目生成的代碼注釋（NC）的數(shù)量。平均為每個項目產(chǎn)生15條注釋，但是5 款軟件有超過105 萬行代碼，產(chǎn)量仍然很低。

4.1 數(shù)據(jù)來源

本文從Github上下載了100款軟件項目，然后在評估中為5個Java目標(biāo)軟件生成注釋，分別為Jabref、Jbidwatcher、Vuze、MegaMek、FreeMind，基本信息如表 3 所示。其中包括評估時使用的軟件，也包括通常評估的代碼克隆檢測項目。這5款軟件在該領(lǐng)域被經(jīng)常使用，具有代表性，且都有很長的歷史時間，比較成熟，也有其他團(tuán)隊在自動生成代碼注釋時選用了這些軟件，因此適合用于實驗。使用CLOC計算每個項目的代碼總數(shù)如表3所示。CLOC是一款在許多編程語言中計算空白行、注釋行和源代碼的物理行的軟件。

表3 軟件基本信息

本文在檢測原項目軟件與目標(biāo)軟件的克隆代碼時，使用Roy 團(tuán)隊開發(fā)的檢測工具Nicad，此工具檢測方法基于文本檢測，能夠高效檢測出原項目軟件和目標(biāo)軟件的 Type-1、Type-2 以及 Type-3 克隆代碼，并將檢測結(jié)果存儲在XML文件中，便于后期數(shù)據(jù)的提取和使用。

4.2 評估標(biāo)準(zhǔn)

本文對所得實驗結(jié)果進(jìn)行了手動驗證，為了獲得更加準(zhǔn)確的代碼注釋，考慮到自動生成注釋的準(zhǔn)確性、充分性、簡潔性等性能，運用了以下的排名標(biāo)準(zhǔn)：

良好：自動生成的代碼注釋在描述目標(biāo)軟件代碼時是準(zhǔn)確、充分、簡潔、符合邏輯的，則被視為是好的注釋，保留此注釋。

中等：自動生成的代碼注釋在描述目標(biāo)軟件代碼時不夠準(zhǔn)確、充分、簡潔，但經(jīng)過小小的修改或改變可以正確描述，則被視為是中等注釋。

不好：自動生成的代碼注釋在描述目標(biāo)軟件代碼時不準(zhǔn)確、不簡潔或者不充分，經(jīng)過修改或改變以后還是無法被修正，則被視為是不好的注釋，不予以推薦。

以上標(biāo)準(zhǔn)對自動生成的代碼注釋的質(zhì)量進(jìn)行評估，如果評估結(jié)果是良好或者中等的，那么在以后的應(yīng)用研究中就適當(dāng)?shù)赝扑]給程序開發(fā)人員。好的代碼注釋可以幫助程序開發(fā)人員節(jié)省閱讀代碼的時間和精力，提高效率。

本文主要對5款軟件進(jìn)行了自動生成注釋的應(yīng)用，以評估生成的代碼注釋的產(chǎn)量和質(zhì)量，采用Wong 等人的標(biāo)準(zhǔn)進(jìn)行評估，為了在以后的研究中可以進(jìn)行對比。

4.3 實驗結(jié)果

（1）生成的代碼注釋的產(chǎn)量

從NC、CG、LC、DC 這四方面對生成的代碼注釋的產(chǎn)量進(jìn)行了評估，實驗結(jié)果的詳細(xì)信息如表4所示。其中NC表示每個項目生成的代碼注釋的數(shù)量；CG表示克隆組；LC 代表目標(biāo)軟件的每個克隆組中的平均代碼克隆數(shù)；DC 描述了軟件存儲庫的每個克隆組中的平均代碼克隆數(shù)；CM表示目標(biāo)項目軟件已經(jīng)存在的代碼注釋。

表4 生成注釋結(jié)果的產(chǎn)量

根據(jù)表4 可以看出，每個克隆組包含平均2.4 個本地克隆和3.4 個數(shù)據(jù)庫克隆，5 款軟件總共生成75 條代碼注釋，平均每款軟件生成15 條代碼注釋。產(chǎn)量相對較低，后續(xù)研究將進(jìn)一步對產(chǎn)量進(jìn)行提高，目前本實驗使用的是Nicad克隆檢測，檢測的克隆代碼數(shù)量還是很低。在以后的研究工作中，可以通過改進(jìn)克隆檢測技術(shù)或利用更高級的代碼克隆檢測工具來提高生成的克隆代碼的數(shù)量，還可以通過使用更多項目擴展數(shù)據(jù)庫來增加克隆組的大小。

表5顯示了克隆組大小的分布。根據(jù)所得數(shù)據(jù)，知道有76.8%的克隆組包含2 個size。在以后的研究中可以通過使用更多項目擴展數(shù)據(jù)庫來增加克隆組的大小，或者利用更高級的代碼克隆檢測技術(shù)。

表5 克隆群代碼克隆的頻率分布

（2）生成的代碼注釋的質(zhì)量

根據(jù)上一節(jié)中提到的評估標(biāo)準(zhǔn)，本文將自動生成的代碼注釋進(jìn)行手動驗證，分為良好、中等和差三個等級，具體信息如表6所示。其中GD表示好的代碼注釋，F(xiàn)X代表可以修復(fù)的注釋，BD 表示壞的代碼注釋。從表中可以看出，得到的好的代碼注釋的數(shù)量不是平均分布的，每一款軟件得到的結(jié)果不同，本文分別計算了自動生成良好代碼注釋、中等注釋以及差的注釋的總和來表現(xiàn)生成代碼注釋的質(zhì)量。本實驗總共生成75條代碼注釋，其中有21（28%）條代碼注釋是良好的，3（4%）條代碼注釋需要被修改，有51（68%）條代碼注釋是壞的。根據(jù)這些數(shù)據(jù)可以發(fā)現(xiàn)，需要被修改的代碼注釋很少。對于中等和差的代碼注釋，將在后續(xù)研究中進(jìn)行總結(jié)，分析問題的來源，通過改進(jìn)實驗進(jìn)一步提高生成代碼注釋的質(zhì)量。

表6 生成注釋結(jié)果的質(zhì)量

自動生成的代碼注釋中，部分注釋在目標(biāo)軟件中是已經(jīng)存在的，本實驗比較了已經(jīng)存在的和自動生成的代碼注釋，人工評估這部分自動生成的代碼注釋與原有注釋比較，是否有改進(jìn)，以便在后續(xù)實驗中進(jìn)行改進(jìn)。根據(jù)表2可知，5款目標(biāo)軟件已有的注釋總數(shù)為26條，占自動生成代碼注釋總數(shù)（76）的34.7%。具體的比較信息如表7所示。其中Better表示生成的代碼注釋比現(xiàn)有的代碼注釋好，Similar表示生成的代碼注釋和現(xiàn)有的代碼注釋相似，Worse表示生成的代碼注釋比現(xiàn)有的代碼注釋差。

表7 自動生成代碼注釋VS現(xiàn)有的代碼注釋 %

由表可以看出，自動生成的代碼注釋相比原有的代碼注釋，在良好的代碼注釋中，3.5%的代碼注釋比原有的更好，25.4%的代碼注釋與原有的代碼注釋相似；在中等的代碼注釋中9.2%的注釋更差?？梢钥闯?，目標(biāo)軟件已有的代碼注釋優(yōu)于自動生成的代碼注釋，但有25.4%自動生成的代碼注釋與現(xiàn)有代碼相似，由來自表4的結(jié)果知，目標(biāo)軟件中有65.3%（100%-34.7%）的注釋以前沒有，是新生成的。這意味著雖然自動生成的代碼注釋通常不如已有代碼注釋更貼近主題，由于生成注釋的工作還沒有很成熟，得到比原有更優(yōu)的3.5%已經(jīng)很不容易，在后續(xù)的實驗中會逐步提高，但為沒有代碼注釋的代碼段生成代碼注釋仍然是有益的。因此，本實驗對于自動生成代碼注釋是有價值的，為以后的工作奠定了一定的基礎(chǔ)。

對于自動生成的代碼注釋，在代碼注釋的相應(yīng)代碼段沒有現(xiàn)有注釋的前提下，本文將評估出的良好的自動生成的代碼注釋報告給5位專家，讓他們也根據(jù)本文的評估標(biāo)準(zhǔn)對這些良好的代碼注釋再次進(jìn)行評估。目前專家對兩款軟件的注釋給予了好評，即也將其視為是良好的代碼注釋，開發(fā)人員認(rèn)為可以將其作為代碼最后的注釋。

4.4 對比實驗及分析

國內(nèi)外通過使用注釋復(fù)用自動生成代碼注釋的方法較少，其中具有代表性的方法是文獻(xiàn)[6]。文獻(xiàn)[6]中Wong 等人通過基于Token 的方法進(jìn)行克隆檢測，而本文使用Nicad基于文本的方法進(jìn)行克隆檢測，中間對于代碼和注釋的處理方法也不同，因此僅對生成的代碼注釋的產(chǎn)量和質(zhì)量進(jìn)行對比。Wong等人實現(xiàn)了一個代碼注釋自動生成工具Clocom。本文研究與文獻(xiàn)[6]都使用從Github上下載的Java開源軟件，實驗的平臺均為操作系統(tǒng)Ubuntu 16.04 64位、8 GB內(nèi)存。產(chǎn)量對比結(jié)果如表8所示。

表8 代碼注釋產(chǎn)量對比結(jié)果

本實驗在克隆檢測階段檢測出的克隆代碼類型比Clocom檢測出的類型多。實驗結(jié)果顯示，在這5款軟件中，本實驗總共生成75 條代碼注釋，Clocom 生成67 條代碼注釋，本實驗比Clocom多生成8條代碼注釋，在代碼注釋產(chǎn)量上高于Clocom。因此在這4個參數(shù)中，本實驗生成代碼注釋的產(chǎn)量相對Clocom較多。

然后對生成代碼注釋的質(zhì)量進(jìn)行了對比，如表9所示。通過表9 可以看出，在生成的代碼注釋中，對于每一款軟件，本實驗生成的代碼注釋的質(zhì)量都比Clocom大約提高5個百分點，5款軟件中有4款在生成的注釋中良好的代碼注釋所占的比例比Clocom大，質(zhì)量較高，有一款軟件良好的代碼注釋所占的比例略微低于Clocom。

表9 生成代碼注釋質(zhì)量對比結(jié)果 %

綜上，本實驗自動生成代碼注釋的產(chǎn)量比Clocom提高了約12%，質(zhì)量也相比于Clocom提高了約5個百分點，均高于Clocom。

5 結(jié)束語

對于現(xiàn)在行業(yè)中代碼注釋數(shù)量稀少、質(zhì)量不高等，導(dǎo)致軟件的可讀性和可維護(hù)性下降的問題，本文提出了一種自動生成代碼注釋的方法來提高注釋的數(shù)量和質(zhì)量，幫助程序員提高代碼的可讀性和可理解性。本文首先通過克隆檢測工具Nicad檢測出開源項目軟件庫和目標(biāo)代碼軟件庫之間的相似代碼即克隆代碼，根據(jù)代碼注釋提取算法通過Nicad 生成的XML 文件提取出克隆代碼；其次根據(jù)行號等提取出相對應(yīng)的代碼注釋；然后對提取出的代碼和注釋經(jīng)過一系列的啟發(fā)式規(guī)則，將克隆代碼和注釋精簡優(yōu)化成所需要的代碼和注釋；最后將注釋與代碼匹配映射，自動為目標(biāo)代碼生成注釋。

本文的研究工作還存在一些不足之處，例如檢測相似克隆代碼時用到的工具，雖然檢測的克隆代碼數(shù)很多，包含Type-1、Type-2和Type-3三種類型，但是時間復(fù)雜度會很高，這會影響到最終實驗結(jié)果的時間效率。在最后的評估中生成代碼注釋的質(zhì)量也很低。本文將在后續(xù)的研究中考慮這些問題，為人們在該領(lǐng)域的研究提供更有力的數(shù)據(jù)，并奠定堅實的基礎(chǔ)。