[發(fā)明專利]一種程序代碼注釋的管理方法及裝置

無效

• 申請(qǐng)?zhí)枺?/td>: 201010233187.1
• 申請(qǐng)日: 2010-07-21
• 公開（公告）號(hào): CN102339218A
• 公開（公告）日: 2012-02-01
• 發(fā)明（設(shè)計(jì)）人: 陽振庭
• 申請(qǐng)（專利權(quán)）人: 陽振庭
• 主分類號(hào): G06F9/44
• 分類號(hào): G06F9/44
• 代理公司: 暫無信息
• 代理人: 暫無信息

技術(shù)領(lǐng)域

本發(fā)明涉及計(jì)算機(jī)軟件領(lǐng)域，尤其涉及在軟件開發(fā)領(lǐng)域的程序代碼注釋的管理方法及裝置。

背景技術(shù)

隨著人類各種應(yīng)用以及硬件芯片技術(shù)的發(fā)展，各種應(yīng)用軟件越來越復(fù)雜和龐大，應(yīng)用軟件一般是由程序代碼經(jīng)過編譯器轉(zhuǎn)化的硬件處理單元能夠識(shí)別的文件組成。復(fù)雜的軟件需要開發(fā)大量的復(fù)雜的程序代碼，因此程序代碼管理問題已經(jīng)變得日益突出，尤其在多人開發(fā)團(tuán)隊(duì)中的程序代碼格式難以統(tǒng)一，減低程序代碼可讀性和可維護(hù)性問題，代碼檢視協(xié)調(diào)困難。

程序代碼一般是文本格式，程序代碼通常為了增加代碼的可讀性以及可維護(hù)性包含了注釋，注釋通常是對(duì)程序代碼的解釋和說明。注釋和程序代碼是作為一個(gè)整體存儲(chǔ)和處理的。注釋是程序代碼可讀性和可維護(hù)性的重要因素，注釋不統(tǒng)一、過多注釋都影響了程序的可讀性以及可維護(hù)性，但是目前各種注釋都是嵌入在程序代碼文件中的，尤其是隨著程序代碼不斷的龐大，程序代碼和代碼注釋的完全耦合在一個(gè)整體中已經(jīng)嚴(yán)重影響了程序代碼的可讀性和可維護(hù)性，降低了軟件程序代碼開發(fā)效率，提高了軟件成本。

代碼檢視是程序代碼開發(fā)中的一個(gè)重要過程，代碼檢視就是開發(fā)人員互相檢視對(duì)方開發(fā)的代碼并且給出修改提示注釋或批注，但是目前程序代碼是無格式的文本，檢視批注不能嵌入到程序代碼中去，這樣就需要手工將檢視批注對(duì)應(yīng)到指定的程序代碼，這樣顯著降低程序開發(fā)團(tuán)隊(duì)合作效率，尤其是隨著程序代碼修改和變動(dòng)，手工對(duì)應(yīng)更加難以處理。

為了解決上述的一些缺陷，提高程序開發(fā)的效率，以及降低軟件成本，本發(fā)明提供一種方法，用來管理程序代碼注釋，實(shí)現(xiàn)程序代碼和注釋的獨(dú)立存儲(chǔ)和同步處理。

發(fā)明內(nèi)容

鑒于上述現(xiàn)有技術(shù)所存在的問題，本發(fā)明實(shí)施例的目的是，一種程序代碼注釋的管理方法及裝置，用于解決注釋嵌入在程序代碼中難以管理的問題，從而實(shí)現(xiàn)注釋和程序代碼的獨(dú)立存儲(chǔ)和同步處理的機(jī)制，提高程序代碼的開發(fā)效率，降低軟件的成本。

上述目的是通過以下技術(shù)方案實(shí)現(xiàn)：

本發(fā)明實(shí)施例提供了一種程序代碼注釋的管理方法，包括：

獲取注釋與程序代碼的關(guān)聯(lián)索引；

根據(jù)所述關(guān)聯(lián)索引對(duì)獨(dú)立的注釋進(jìn)行同步處理。

上述的獲取注釋與程序代碼的關(guān)聯(lián)索引包括：分析所述的程序代碼獲取注釋與程序代碼的關(guān)聯(lián)索引。

上述的獲取注釋與程序代碼的關(guān)聯(lián)索引還包括：從注釋庫中獲取注釋與程序代碼的關(guān)聯(lián)索引。

上述的關(guān)聯(lián)索引包括下列中的一種或多種組合：顯式關(guān)聯(lián)索引、程序代碼的庫名、程序代碼的行號(hào)、程序代碼的符號(hào)。

上述的根據(jù)所述關(guān)聯(lián)索引對(duì)獨(dú)立的注釋進(jìn)行同步處理包括：

根據(jù)所述的關(guān)聯(lián)索引獲取對(duì)應(yīng)的注釋；

根據(jù)所述的關(guān)聯(lián)索引在程序代碼的對(duì)應(yīng)位置輸出注釋。

或

根據(jù)所述的關(guān)聯(lián)索引獲取對(duì)應(yīng)的注釋；

刪除所述的注釋。

或

輸入所述的關(guān)聯(lián)索引對(duì)應(yīng)的注釋；

存儲(chǔ)所述的關(guān)聯(lián)索引和所述的注釋。

或

根據(jù)所述的關(guān)聯(lián)索引獲取對(duì)應(yīng)的注釋；

將所述的注釋插入到所述的關(guān)聯(lián)索引對(duì)應(yīng)的程序代碼的位置上。

本發(fā)明實(shí)施例又提供了一種程序代碼注釋的管理裝置，包括：

代碼輸入輸出模塊，用于程序代碼的輸入輸出處理；

注釋輸入輸出模塊，用于注釋的輸入輸出處理；

代碼注釋關(guān)聯(lián)模塊，用于程序代碼和注釋的映射處理，所述映射處理包括：代碼注釋關(guān)聯(lián)模塊根據(jù)關(guān)聯(lián)索引進(jìn)行映射，同時(shí)通知代碼輸入輸出模塊或注釋輸入輸出模塊進(jìn)行處理。

上述的一種程序代碼注釋的管理裝置還可以包括：

代碼存儲(chǔ)模塊，用于存儲(chǔ)程序代碼；

注釋存儲(chǔ)模塊，用于存儲(chǔ)注釋和關(guān)聯(lián)索引。

由上述本發(fā)明實(shí)施例提供的技術(shù)方案可以看出，本發(fā)明實(shí)施例提供了一種程序代碼注釋管理的方法及裝置，解決了注釋嵌入在程序代碼中的一些缺陷，提高程序開發(fā)的效率，以及降低軟件成本。

附圖說明

圖1為本發(fā)明的程序代碼管理的應(yīng)用環(huán)境圖；

圖2為本發(fā)明的程序代碼管理的裝置圖；

圖3為本發(fā)明的代碼注釋管理中的同步輸出注釋示意圖；

圖4為本發(fā)明的代碼注釋管理中的給程序代碼增加注釋示意圖；

圖5為本發(fā)明的將獨(dú)立的注釋合并到程序代碼里的示意圖；

圖6為本發(fā)明的將程序代碼包含的注釋分離出來的示意圖。

具體實(shí)施方式