專利名稱：一種程序代碼注釋的管理方法及裝置的制作方法
技術領域：
本發(fā)明涉及計算機軟件領域，尤其涉及在軟件開發(fā)領域的程序代碼注釋的管理方法及裝置。
背景技術：
隨著人類各種應用以及硬件芯片技術的發(fā)展，各種應用軟件越來越復雜和龐大， 應用軟件一般是由程序代碼經(jīng)過編譯器轉(zhuǎn)化的硬件處理單元能夠識別的文件組成。復雜的軟件需要開發(fā)大量的復雜的程序代碼，因此程序代碼管理問題已經(jīng)變得日益突出，尤其在多人開發(fā)團隊中的程序代碼格式難以統(tǒng)一，減低程序代碼可讀性和可維護性問題，代碼檢視協(xié)調(diào)困難。程序代碼一般是文本格式，程序代碼通常為了增加代碼的可讀性以及可維護性包含了注釋，注釋通常是對程序代碼的解釋和說明。注釋和程序代碼是作為一個整體存儲和處理的。注釋是程序代碼可讀性和可維護性的重要因素，注釋不統(tǒng)一、過多注釋都影響了程序的可讀性以及可維護性，但是目前各種注釋都是嵌入在程序代碼文件中的，尤其是隨著程序代碼不斷的龐大，程序代碼和代碼注釋的完全耦合在一個整體中已經(jīng)嚴重影響了程序代碼的可讀性和可維護性，降低了軟件程序代碼開發(fā)效率，提高了軟件成本。代碼檢視是程序代碼開發(fā)中的一個重要過程，代碼檢視就是開發(fā)人員互相檢視對方開發(fā)的代碼并且給出修改提示注釋或批注，但是目前程序代碼是無格式的文本，檢視批注不能嵌入到程序代碼中去，這樣就需要手工將檢視批注對應到指定的程序代碼，這樣顯著降低程序開發(fā)團隊合作效率，尤其是隨著程序代碼修改和變動，手工對應更加難以處理。為了解決上述的一些缺陷，提高程序開發(fā)的效率，以及降低軟件成本，本發(fā)明提供一種方法，用來管理程序代碼注釋，實現(xiàn)程序代碼和注釋的獨立存儲和同步處理。

發(fā)明內(nèi)容
鑒于上述現(xiàn)有技術所存在的問題，本發(fā)明實施例的目的是，一種程序代碼注釋的管理方法及裝置，用于解決注釋嵌入在程序代碼中難以管理的問題，從而實現(xiàn)注釋和程序代碼的獨立存儲和同步處理的機制，提高程序代碼的開發(fā)效率，降低軟件的成本。上述目的是通過以下技術方案實現(xiàn)本發(fā)明實施例提供了一種程序代碼注釋的管理方法，包括獲取注釋與程序代碼的關聯(lián)索引；根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理。上述的獲取注釋與程序代碼的關聯(lián)索引包括分析所述的程序代碼獲取注釋與程序代碼的關聯(lián)索引。上述的獲取注釋與程序代碼的關聯(lián)索引還包括從注釋庫中獲取注釋與程序代碼的關聯(lián)索引。上述的關聯(lián)索引包括下列中的一種或多種組合顯式關聯(lián)索引、程序代碼的庫名、程序代碼的行號、程序代碼的符號。上述的根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理包括根據(jù)所述的關聯(lián)索引獲取對應的注釋；根據(jù)所述的關聯(lián)索引在程序代碼的對應位置輸出注釋?；蚋鶕?jù)所述的關聯(lián)索引獲取對應的注釋；刪除所述的注釋。或輸入所述的關聯(lián)索引對應的注釋；存儲所述的關聯(lián)索引和所述的注釋?；蚋鶕?jù)所述的關聯(lián)索引獲取對應的注釋；將所述的注釋插入到所述的關聯(lián)索引對應的程序代碼的位置上。本發(fā)明實施例又提供了一種程序代碼注釋的管理裝置，包括代碼輸入輸出模塊，用于程序代碼的輸入輸出處理；注釋輸入輸出模塊，用于注釋的輸入輸出處理；代碼注釋關聯(lián)模塊，用于程序代碼和注釋的映射處理，所述映射處理包括代碼注釋關聯(lián)模塊根據(jù)關聯(lián)索引進行映射，同時通知代碼輸入輸出模塊或注釋輸入輸出模塊進行處理。上述的一種程序代碼注釋的管理裝置還可以包括代碼存儲模塊，用于存儲程序代碼；注釋存儲模塊，用于存儲注釋和關聯(lián)索引。由上述本發(fā)明實施例提供的技術方案可以看出，本發(fā)明實施例提供了一種程序代碼注釋管理的方法及裝置，解決了注釋嵌入在程序代碼中的一些缺陷，提高程序開發(fā)的效率，以及降低軟件成本。


圖1為本發(fā)明的程序代碼管理的應用環(huán)境圖；圖2為本發(fā)明的程序代碼管理的裝置圖；圖3為本發(fā)明的代碼注釋管理中的同步輸出注釋示意圖；圖4為本發(fā)明的代碼注釋管理中的給程序代碼增加注釋示意圖；圖5為本發(fā)明的將獨立的注釋合并到程序代碼里的示意圖；圖6為本發(fā)明的將程序代碼包含的注釋分離出來的示意圖。
具體實施例方式下面結(jié)合附圖對本發(fā)明的實施方式進行詳細說明。首先，介紹程序代碼注釋的管理方法的即本發(fā)明的應用環(huán)境，請參閱附圖1，程序代碼注釋的管理方法在代碼注釋管理程序中實現(xiàn)，代碼注釋管理程序是實現(xiàn)代碼注釋管理的指令集合，代碼注釋管理程序裝載在102存儲單元中，101軟件處理單元負責執(zhí)行代碼注釋管理程序，即101軟件處理單元從102存儲單元獲取所述指令然后執(zhí)行所述的指令，101 軟件處理單元可以根據(jù)所述的代碼注釋管理程序的指令從104輸入單元中接收輸入，101 軟件處理單元還可以根據(jù)所述的代碼注釋管理程序的指令將執(zhí)行結(jié)果輸出到103輸出單元，進一步，101軟件處理單元還將從104輸入單元接收到的輸入存儲到102存儲單元中。 其中，101軟件處理單元具體實現(xiàn)包括CPU (Central Processing Unit，中央處理單元)等， 102存儲單元具體實現(xiàn)包括內(nèi)存等，103輸出單元具體實現(xiàn)包括顯示器、顯示終端等，104輸入單元具體實現(xiàn)包括鍵盤、鼠標、手寫筆等。101軟件處理單元、102存儲單元、103輸出單元以及104輸入單元協(xié)調(diào)合作，構(gòu)成了代碼注釋管理程序的基本運行環(huán)境。代碼注釋管理程序負責同步輸出注釋、同步刪除注釋、同步輸入注釋、同步合并注釋以及同步分離注釋。程序代碼和注釋是獨立存儲的，即注釋不是嵌入在程序代碼中的，程序代碼和注釋通過關聯(lián)索引進行映射或關聯(lián)，關聯(lián)索引包括顯式關聯(lián)索引、程序代碼的庫名、程序代碼的行號、程序代碼的符號中的一種或多種組合，其中程序代碼的庫名具體包括程序代碼文件名、程序代碼數(shù)據(jù)庫名等。同步輸出注釋負責在程序代碼的對應位置輸出或顯示注釋，主要包括分析程序代碼獲取關聯(lián)索引或從注釋庫中獲取關聯(lián)索引，然后從注釋庫中獲取關聯(lián)索引對應的注釋，然后根據(jù)關聯(lián)索引在程序代碼的對應位置輸出或顯示注釋。同步刪除注釋負責從注釋庫中刪除注釋，主要包括分析程序代碼獲取待刪除注釋的關聯(lián)索引或從注釋庫中獲取待刪除注釋的關聯(lián)索引，根據(jù)關聯(lián)索引從注釋庫中獲取對應的注釋；然后從注釋庫中刪除所述的注釋和關聯(lián)索引，如果程序代碼中存在顯式關聯(lián)索弓I，則在程序代碼中同步刪除顯式關聯(lián)索引。同步輸入注釋主要包括分析程序代碼獲取待增加注釋的程序代碼的關聯(lián)索引， 輸入或編輯關聯(lián)索引對應的注釋；存儲所述的關聯(lián)索引和所述的注釋。合并注釋主要包括從注釋庫中獲取待合并注釋的關聯(lián)索引，根據(jù)所述的關聯(lián)索引從注釋庫中獲取對應的注釋；將所述的注釋插入到所述的關聯(lián)索引對應的程序代碼的位置上。分離注釋主要包括分析程序代碼獲取程序代碼中的注釋以及注釋對應的關聯(lián)索引；存儲所述的關聯(lián)索引和所述的注釋；刪除程序代碼中的注釋，如果是顯式索引，則在程序代碼中增加顯式索引。通過上述的代碼注釋管理程序，程序代碼和注釋存儲在不同的庫中，代碼注釋管理程序負責程序代碼和注釋的關聯(lián)或?qū)?，即將指定程序代碼與指定的注釋互相對應起來成為一個整體，同時可以方便的將程序代碼中的注釋分離出來獨立存儲，也可以將獨立的注釋合并到程序代碼中去，從而實現(xiàn)獨立存儲的程序代碼和注釋能夠同步處理，實現(xiàn)程序代碼和注釋靈活管理，大大提高程序代碼開發(fā)的效率。需要說明的是，上述應用環(huán)境具體實現(xiàn)可以多種多樣，包括但不限于個人計算機、 服務器、手持終端、筆記本電腦。本發(fā)明還描述了程序代碼管理的裝置，請參閱附圖3，程序代碼管理的裝置包括 201代碼輸入輸出模塊、202注釋輸入輸出模塊、203代碼注釋關聯(lián)模塊、204代碼存儲模塊和205注釋存儲模塊。201代碼輸入輸出模塊負責程序代碼的輸入輸出處理，通常稱之為代碼編輯，具體包括從輸入單元接收程序代碼的輸入，并將輸入的程序代碼存儲到204代碼存儲模塊。201代碼輸入輸出模塊具體實現(xiàn)包括但不限于編輯窗口或文本框或編輯框。202 注釋輸入輸出模塊負責注釋的輸入輸出處理，具體包括從輸入單元接收注釋的輸入，并將輸入的注釋存儲到205注釋存儲模塊。202注釋輸入輸出模塊具體實現(xiàn)包括但不限于編輯窗口或文本框或編輯框。203代碼注釋關聯(lián)模塊負責程序代碼和注釋的映射，203代碼注釋關聯(lián)模塊根據(jù)關聯(lián)索引進行映射，同時通知201代碼輸入輸出模塊或202注釋輸入輸出模塊進行處理。顯式關聯(lián)索引指在程序代碼中顯式地增加一個關聯(lián)索引標記，例如在C預言代碼中顯式地增加一個標記，如/*注釋#000 *八203代碼注釋關聯(lián)模塊根據(jù)關聯(lián)索引將程序代碼對應到指定的注釋或?qū)⒆⑨寣街付ǖ某绦虼a。一般的，如果一段程序代碼或一行程序代碼或一個程序代碼符號存在注釋，203代碼注釋關聯(lián)模塊從所述的一段程序代碼或一行程序代碼或一個程序代碼符號獲取關聯(lián)索引并將關聯(lián)索引傳遞給202注釋輸入輸出模塊，202注釋輸入輸出模塊根據(jù)關聯(lián)索引輸入或輸出其對應的注釋。204代碼存儲模塊負責存儲程序代碼，例如204代碼存儲模塊實現(xiàn)程序代碼讀寫，代碼存儲模塊從磁盤、數(shù)據(jù)庫等存儲功能體上讀取程序代碼或者將程序代碼寫入存儲功能體中。205注釋存儲模塊負責將注釋和關聯(lián)索引作為注釋庫存儲，注釋庫存儲在磁盤、數(shù)據(jù)庫等存儲功能體上。 204代碼存儲模塊和205注釋存儲模塊實現(xiàn)了程序代碼和注釋的獨立存儲，201代碼輸入輸出模塊和202注釋輸入輸出模塊通過203代碼注釋關聯(lián)模塊對程序代碼和注釋進行同步處理。這樣可以方便實現(xiàn)程序代碼和注釋互不影響，同時也可以容易實現(xiàn)檢視批注的自動對應以及同步管理，提高了程序代碼的可維護性以及可讀性，降低程序代碼的開發(fā)成本。下面是程序代碼管理步驟以及相關操作，同時結(jié)合上面裝置實施例的詳細描述。附圖3描述了代碼注釋管理中的同步輸出注釋的步驟，具體包括步驟301，獲取關聯(lián)索引。獲取關聯(lián)索引包括自動觸發(fā)或輸入命令觸發(fā)分析程序代碼，然后根據(jù)分析獲取關聯(lián)索引，輸入觸發(fā)包括鍵盤按鍵輸入、鼠標按鍵輸入等，自動觸發(fā)包括初始載入程序代碼、更新程序代碼等。具體實現(xiàn)包括代碼輸入輸出模塊接收輸入焦點，代碼輸入輸出模塊接收的輸入焦點包括快捷鍵、鼠標按鍵等操作信息。代碼輸入輸出模塊將輸入焦點信息以及程序代碼傳遞給代碼注釋關聯(lián)模塊，代碼注釋關聯(lián)模塊分析程序代碼，獲取輸入焦點對應的關聯(lián)索引。例如代碼輸入輸出模塊獲取快捷鍵或鼠標按鍵的位置，所述的位置包括但不限于行號、列號，代碼注釋關聯(lián)模塊分析程序代碼，根據(jù)輸入焦點的位置對應的代碼對象構(gòu)造關聯(lián)索引。所述的代碼對象包括但不局限于當前的程序代碼文件名或庫名、行號、程序代碼符號或顯式關聯(lián)索引。代碼注釋關聯(lián)模塊將關聯(lián)索引傳遞給注釋輸入輸出模塊。步驟302，根據(jù)關聯(lián)索引獲取注釋。注釋輸入輸出模塊根據(jù)關聯(lián)索引通過注釋存儲模塊在注釋庫中查找對應的注釋，如果存在對應的注釋，注釋輸入輸出模塊從注釋存儲模塊獲取注釋。步驟303，輸出注釋信息。注釋輸入輸出模塊通常將注釋輸出到編輯窗口或文本框或編輯框，然后通過輸出單元將包含注釋的編輯窗口或文本框或編輯框顯示出來。通過附圖3所述的方法，程序代碼開發(fā)時可以按需輸出或顯示指定的注釋，可以使程序代碼更加整潔，同時注釋更加具有針對性，提高了程序代碼的可讀性和可維護性。附圖4描述了代碼注釋管理中的給程序代碼增加注釋的步驟，具體包括步驟401、接收增加注釋命令。下發(fā)增加注釋的命令，接收增加注釋命令，并且獲取待增加注釋的代碼對象。例如代碼輸入輸出模塊接收來自菜單或按鈕的命令，在當前輸入焦點位置或?qū)x中的代碼對象增加注釋。所述的注釋包括對程序代碼進行解釋或說明的注釋，還可以包括檢視批注。代碼輸入輸出模塊通知代碼注釋關聯(lián)模塊分析代碼和增加注釋。所述選中的代碼對象包括但不限于代碼符號，所述的代碼符號包括但不限于函數(shù)名、全局變量、類型聲明、宏定義、控制語句、條件語句等。步驟402、獲取關聯(lián)索引。分析程序代碼，然后根據(jù)分析獲取關聯(lián)索引。具體實現(xiàn)包括代碼注釋關聯(lián)模塊分析需要增加注釋的程序代碼對象，然后根據(jù)程序代碼對象構(gòu)造關聯(lián)索引，代碼注釋關聯(lián)模塊還可以通知代碼輸入輸出模塊為程序代碼增加顯式的關聯(lián)索引，比如代碼輸入輸出模塊在需要增加注釋的程序代碼對象的周圍增加用于關聯(lián)索引的注釋，如//注釋#0009。代碼注釋關聯(lián)模塊將關聯(lián)所以傳遞給注釋輸入輸出模塊。步驟403、編輯注釋。根據(jù)關聯(lián)索引增加注釋，注釋是手工輸入的數(shù)據(jù)信息，最典型就是字符串。所述的注釋可以是對關聯(lián)索引所指的程序代碼的說明或解釋，也可以是對關聯(lián)索引所指的程序代碼的檢視批注。具體實現(xiàn)如注釋輸入輸出模塊接收輸入的數(shù)據(jù)作為注釋，然后將注釋通過注釋存儲模塊存儲到注釋庫中。注釋輸入輸出模塊可以通過輸入窗口或編輯框或文本框接收注釋。步驟404、存儲注釋。注釋輸入輸出模塊將注釋以及關聯(lián)索引傳遞給注釋存儲模塊，注釋存儲模塊存儲注釋以及關聯(lián)索引到注釋庫。注釋庫可以為文件，也可以為數(shù)據(jù)庫。 存儲方式取決具體實現(xiàn)。附圖5描述了代碼注釋管理中的將獨立的注釋合并到程序代碼里的步驟，具體包括步驟501、獲取關聯(lián)索引以及注釋。注釋輸入輸出模塊通過注釋存儲模塊從注釋庫中獲取關聯(lián)索引以及注釋，注釋輸入輸出模塊將關聯(lián)索引以及注釋傳遞給代碼注釋關聯(lián)模塊。步驟502、獲取關聯(lián)索引在程序代碼中對應的位置。代碼注釋關聯(lián)模塊分析程序代碼，確定關聯(lián)索引在程序代碼中對應的位置，然后通知代碼輸入輸出模塊在指定位置增加注釋。步驟503、在程序代碼對應的位置插入注釋。代碼輸入輸出模塊在程序代碼的指定位置插入注釋。代碼輸入輸出模塊根據(jù)程序代碼的語言特征增加符合程序代碼語言格式的注釋。例如如果程序代碼是C語言，則插入的是/**/格式的注釋。附圖6描述了代碼注釋管理中的將程序代碼包含的注釋分離出來的步驟，具體包括步驟601、解析程序代碼獲取關聯(lián)索引和注釋。代碼輸入輸出模塊載入程序代碼， 代碼輸入輸出模塊將程序代碼交給代碼注釋關聯(lián)模塊進行分析，代碼注釋關聯(lián)模塊通過詞法和語法分析得到程序代碼中的注釋以及注釋所在位置或注釋對應的程序代碼對象。注釋關聯(lián)模塊根據(jù)注釋所在位置或注釋對應的程序代碼對象構(gòu)造關聯(lián)索引。注釋關聯(lián)模塊通知注釋輸入輸出模塊存儲注釋以及關聯(lián)索引。步驟602、存儲注釋以及關聯(lián)索引。注釋輸入輸出模塊存儲注釋以及關聯(lián)索引到注釋存儲模塊。步驟603、移除程序代碼中的注釋。注釋關聯(lián)模塊通知代碼輸入輸出模塊移除指定注釋，注釋關聯(lián)模塊還可以通知代碼輸入輸出模塊增加顯式關聯(lián)索引。代碼輸入輸出模塊在程序代碼的指定位置移除指定注釋，代碼輸入輸出模塊還可以在程序代碼的指定位置增加顯式關聯(lián)索引。通常顯式關聯(lián)索引作為注釋添加在程序代碼中。
以上所述，僅為本發(fā)明實施例較佳的具體實施方式
，但本發(fā)明實施例的保護范圍并不局限于此，任何熟悉本技術領域的技術人員在本發(fā)明實施例揭露的技術范圍內(nèi)，可輕易想到的變化或替換，都應涵蓋在本發(fā)明實施例的保護范圍之內(nèi)。因此，本發(fā)明實施例的保護范圍應該以權利要求的保護范圍為準。
權利要求
1.一種程序代碼注釋的管理方法，其特征在于，包括 獲取注釋與程序代碼的關聯(lián)索引；根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理。
2.根據(jù)權利要求1所述的方法，其特征在于，所述的獲取注釋與程序代碼的關聯(lián)索引包括分析所述的程序代碼獲取注釋與程序代碼的關聯(lián)索引或從注釋庫中獲取注釋與程序代碼的關聯(lián)索引。
3.根據(jù)權利要求1或2所述的方法，其特征在于，所述的關聯(lián)索引包括下列中的一種或多種組合顯式關聯(lián)索引、程序代碼的庫名、程序代碼的行號、程序代碼的符號。
4.根據(jù)權利要求1所述的方法，其特征在于，所述的根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理包括根據(jù)所述的關聯(lián)索引獲取對應的注釋；根據(jù)所述的關聯(lián)索引在程序代碼的對應位置輸出注釋。
5.根據(jù)權利要求1所述的方法，其特征在于，所述的根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理包括根據(jù)所述的關聯(lián)索引獲取對應的注釋； 刪除所述的注釋。
6.根據(jù)權利要求1所述的方法，其特征在于，所述的根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理包括輸入所述的關聯(lián)索引對應的注釋； 存儲所述的關聯(lián)索引和所述的注釋。
7.根據(jù)權利要求1所述的方法，其特征在于，所述的根據(jù)所述關聯(lián)索引對獨立的注釋進行同步處理包括根據(jù)所述的關聯(lián)索引獲取對應的注釋；將所述的注釋插入到所述的關聯(lián)索引對應的程序代碼的位置上。
8.一種程序代碼注釋的管理裝置，其特征在于，包括 代碼輸入輸出模塊，用于程序代碼的輸入輸出處理； 注釋輸入輸出模塊，用于注釋的輸入輸出處理；代碼注釋關聯(lián)模塊，用于程序代碼和注釋的映射處理，所述映射處理包括代碼注釋關聯(lián)模塊根據(jù)關聯(lián)索引進行映射，同時通知代碼輸入輸出模塊或注釋輸入輸出模塊進行處理。
9.根據(jù)權利要求8所述的裝置，其特征在于，所述的一種程序代碼注釋管理的裝置進一步包括代碼存儲模塊，用于存儲程序代碼； 注釋存儲模塊，用于存儲注釋和關聯(lián)索引。
全文摘要
本發(fā)明公開了一種程序代碼注釋的管理方法及裝置。其中，所述程序代碼注釋的管理方法，包括分析程序代碼獲取注釋與程序代碼的關聯(lián)索引或從注釋庫中獲取注釋與程序代碼的關聯(lián)索引；根據(jù)所述關聯(lián)索引對獨立的注釋進行與程序代碼的同步處理。所述程序代碼注釋管理裝置，包括代碼輸入輸出模塊、注釋輸入輸出模塊、代碼注釋關聯(lián)模塊、代碼存儲模塊、注釋存儲模塊。通過本發(fā)明的方法和裝置，簡單解決了程序代碼注釋獨立管理的問題，提高了程序開發(fā)的效率。
文檔編號G06F9/44GK102339218SQ20101023318
公開日2012年2月1日 申請日期2010年7月21日 優(yōu)先權日2010年7月21日
發(fā)明者陽振庭 申請人:陽振庭