[發明專利]一種幫助文檔生成裝置和方法

無效

• 申請號: 201010606458.3
• 申請日: 2010-12-21
• 公開（公告）號: CN102063300A
• 公開（公告）日: 2011-05-18
• 發明（設計）人: 羅帆
• 申請（專利權）人: 深圳市金蝶中間件有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京三高永信知識產權代理有限責任公司 11138
• 代理人: 鄭光

技術領域

本發明涉及計算機技術領域，特別涉及一種幫助文檔生成裝置和方法。

背景技術

JavaDoc是Sun公司開發的一項技術，能夠從程序源代碼中抽取類、方法、成員等注釋，以形成一個和源代碼配套的API(Java?Application?Interface，應用編程接口)幫助文檔。這樣只要在編寫程序時以預定的方式對源代碼做出注釋，就可以在程序編寫完成后通過JavaDoc就可以獲得相應格式的開發文檔。

現有的JavaDoc是由開發人員在程序源代碼上以注釋的方式進行撰寫的，而撰寫的標準格式是以HTML格式。

Wiki(維基)格式是現有的一種新興的互聯網格式，使用者可以在互聯網上對wiki文本進行瀏覽、創建、更改，而且創建、更改、發布的代價遠比HTML文本為小。

在實現本發明的過程中，發明人發現現有技術至少存在以下問題：

HTML格式學習成本較高，開發人員需要學習眾多的標簽才能完整的書寫JavaDoc，學和維護成本過高。且HTML格式是一種腳本語言，因此現有的采用HTML格式的JavaDoc直觀性并不好。同時，JavaDoc不支持現有的wiki格式。

發明內容

為了解決現有技術中存在的現有的采用HTML格式的JavaDoc直觀性不好且維護成本過高的問題，本發明實施例提出了一種幫助文檔生成裝置和方法。所述技術方案如下：

本發明實施例提出了一種幫助文檔生成方法，包括：

在源代碼中采用wiki格式添加注釋；

將所述wiki格式的注釋轉換為HTML格式。

本發明實施例提出了一種幫助文檔生成裝置，包括：

源代碼模塊，用于存儲源代碼，以及記載于所述源代碼中的注釋，所述注釋采用wiki格式撰寫；

轉換模塊，用于將所述wiki格式的注釋轉換為HTML格式。

本發明實施例提供的技術方案帶來的有益效果是：本發明實施例中，可以使用戶通過簡單易懂的wiki格式撰寫JavaDoc，然后再將其轉換成HTML格式，以降低用戶的使用復雜度。同時，訪問wiki的要求只是因特網連接和一個Web瀏覽器，比其他一些協作應用程序和組件容易部署和使用。

附圖說明

圖1為本發明第一實施例的流程示意圖；

圖2為本發明第三實施例的結構示意圖。

具體實施方式

為使本發明的目的、技術方案和優點更加清楚，下面將結合附圖對本發明實施方式作進一步地詳細描述。

實施例1

本發明第一實施例提出了一種幫助文檔生成方法，其流程如圖1所示的，包括：

步驟101、在源代碼中采用wiki格式添加注釋；

步驟102、將所述wiki格式的注釋轉換為HTML格式。

本發明實施例中，可以使用戶通過簡單易懂的wiki格式撰寫JavaDoc，然后再將其轉換成HTML格式，以降低用戶的使用復雜度。同時，訪問wiki的要求只是因特網連接和一個Web瀏覽器，比其他一些協作應用程序和組件容易部署和使用。

實施例2

本發明第二實施例提出了一種幫助文檔生成方法，是在前述第一實施例的基礎上改進而來，所述方法具體為：

步驟201、用戶針對每個欲生成API文檔的類、方法、函數體等使用wiki格式撰寫注釋；

步驟202、通過wikiRedener將wiki格式的注釋轉換成對應的HTML格式。

本發明實施例中，可以通過現有的wikiRedener進行格式轉換。當然，這只是實現本發明的一種方式。由于JavaDoc具有特定的HTML格式，因此可以通過其他形式的轉換器進行轉碼，本發明實施例并不對此做出限定。

實施例3

本發明第一實施例提出了一種幫助文檔生成裝置，其結構如圖2所示的，包括：

源代碼模塊1，用于存儲源代碼，以及記載于所述源代碼中的注釋，所述注釋采用wiki格式撰寫；

轉換模塊2，用于將所述wiki格式的注釋轉換為HTML格式。

本發明實施例中，可以使用戶通過簡單易懂的wiki格式撰寫JavaDoc，然后再將其轉換成HTML格式，以降低用戶的使用復雜度。同時，訪問wiki的要求只是因特網連接和一個Web瀏覽器，比其他一些協作應用程序和組件容易部署和使用。

實施例4

本發明第四實施例提出了一種幫助文檔生成裝置，是在前述第三實施例的基礎上改進而來，所述系統包括：

源代碼模塊1，用于存儲源代碼，以及記載于所述源代碼中的注釋，所述注釋采用wiki格式撰寫。