[發明專利]一種生成代碼說明文檔的方法及裝置

無效

• 申請號: 201010004284.3
• 申請日: 2010-01-20
• 公開（公告）號: CN102129365A
• 公開（公告）日: 2011-07-20
• 發明（設計）人: 趙旭
• 申請（專利權）人: 阿里巴巴集團控股有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京集佳知識產權代理有限公司 11227
• 代理人: 逯長明;王寶筠

技術領域

本申請涉及計算機技術領域，尤其涉及一種生成代碼說明文檔的方法及裝置。

背景技術

Javadoc可以從源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的應用程序編程接口(API，Application?Programming?Interface)代碼說明文檔。也就是說，程序員在編寫源代碼時以特定的標簽作注釋，在源代碼編寫完成后，通過Javadoc就可以得到代碼說明文檔。代碼說明文檔可以使受眾快速了解源代碼的含義。

但在具體的大型項目開發中，參與開發的人員極多，例如，在一個軟件公司內部，一個大型項目的開發涉及到跨部門之間的合作，甚至有些部分需要委托公司外部的人員完成。該項目的開發主導者并不希望所有參與開發的人員都得到一樣的代碼說明文檔，比如：對于本公司外部的人員，開發主導者并不希望他們了解到一些源代碼的重要信息，而對于公司內部的測試人員，則需要讓他們了解更多的內容以編寫測試用例。但現有的Javadoc技術僅能提供一種代碼說明文檔。

發明內容

本申請實施例的目的是提供一種生成代碼說明文檔的方法及裝置，可以根據不同的受眾分別生成不同的代碼說明文檔。

一種生成代碼說明文檔的方法，所述方法包括：

接收生成代碼說明文檔的指令，所述生成代碼說明文檔的指令中包含類標識、方法標識和標簽，所述標簽用于標識出生成不同受眾類型的代碼說明文檔所需的注釋內容；

根據所述類標識從指定的源代碼中查詢到目標類，并在所述目標類中依據所述方法標識查找到目標方法；

在所述目標方法的注釋中依據所述標簽過濾查找到所需的注釋內容，以保留符合不同受眾類型要求的注釋；

將過濾后的注釋內容生成符合不同受眾類型要求的代碼說明文檔。

優選的，在所述目標方法的注釋中依據所述標簽過濾查找到的方法注釋之后，所述方法還包括：

輸出在所述目標方法的注釋中過濾查找到的所需的注釋內容。

優選的，在所述將過濾后的注釋內容生成符合不同受眾類型要求的代碼說明文檔之前，所述方法還包括：

當所述目標類為多個時，分別對所述源代碼中的其它目標類執行與所述目標類相同的操作；

則所述將查找過濾的注釋內容生成符合不同受眾類型要求的代碼說明文檔包括：

針對所述源代碼中的各個目標類，將過濾后的注釋內容生成代碼說明文檔。

優選的，在所述將查找過濾后的注釋內容生成代碼說明文檔之后，所述方法還包括：

將生成的所述代碼說明文檔按照不同的受眾類型展現給用戶。

一種生成代碼說明文檔的裝置，所述裝置包括：

接收單元，用于接收生成代碼說明文檔的指令，所述生成代碼說明文檔的指令中包含類標識、方法標識和標簽，所述標簽用于標識出生成不同受眾類型的代碼說明文檔所需的注釋內容；

檢索單元，用于根據所述類標識從指定的源代碼中查詢到目標類；

查找單元，用于在所述檢索單元檢索出的目標類中依據所述方法標識查找到目標方法；

過濾單元，用于根據在所述目標方法的注釋中依據所述標簽過濾查找到所需的注釋內容，以保留符合不同受眾類型要求的注釋；

生成單元，用于將過濾后的注釋內容生成符合不同受眾類型要求的代碼說明文檔。

優選的，所述裝置還包括：

輸出單元，用于在所述過濾單元執行操作之后，輸出在所述目標方法的注釋中過濾查找到的所需的注釋內容。

優選的，所述裝置還包括：

繼續執行單元，用于在所述生成單元執行操作之前，當所述目標類為多個時，分別對所述源代碼中的其它目標類執行與所述目標類相同的操作；

所述生成單元用于還針對所述源代碼中的各個目標類，將過濾后的注釋內容生成代碼說明文檔。

優選的，所述裝置還包括：

展現單元，用于在所述生成單元執行操作之后，將所述生成單元生成的代碼說明文檔按照不同的受眾類型展現給用戶。