[發明專利]注釋說明的生成方法及裝置

在審

• 申請號: 201611204503.6
• 申請日: 2016-12-23
• 公開（公告）號: CN108241503A
• 公開（公告）日: 2018-07-03
• 發明（設計）人: 陳煥君
• 申請（專利權）人: 北京國雙科技有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 北京鼎佳達知識產權代理事務所(普通合伙) 11348
• 代理人: 王偉鋒;劉鐵生

本發明公開了一種注釋說明的生成方法及裝置，涉及計算機技術領域，主要目的在于解決代碼文件中的注釋更改后，需要人為修改注釋文件的問題。本發明的主要技術方案為：讀取源代碼文件；從所述源代碼文件中獲取接口注釋信息及接口調用信息，所述接口注釋信息包括接口功能注釋信息及接口參數注釋信息，所述接口調用信息包括接口調用參數信息及接口調用類型信息；定義多個用于存儲信息的變量；將所述接口注釋信息及所述接口調用信息分別存儲在對應的變量中；根據存儲在變量中的接口注釋信息及接口調用信息，以及預置注釋轉換規則生成所述源代碼文件對應的注釋說明文件。主要用于注釋說明的生成。

技術領域

本發明涉及計算機技術領域，尤其涉及一種注釋說明的生成方法及裝置。

背景技術

應用程序編程接口(Application Programming Interface,API)在提供調用接口的同時，會給調用接口方也提供一個說明文檔，使得調用接口方通過說明文檔了解調用接口的功能、接口返回的數據格式、調用接口參數等。

目前，可以通過在系統控制器中的源文件里添加注釋，然后按照apidoc規則生成html格式的文檔，或者安裝一個helppage安裝包，將源文件里的注釋添加在.cs格式的文件中，還可以將API的注釋直接編寫在.js格式的文件里，得到說明文檔。但是，helppage安裝包生成.cs格式的說明文檔無法實現調用接口，另外，當需要更改注釋或添加注釋時，需要手動修改源文件中的注釋，重新按照apidoc規則生成html格式的文檔，或者直接重新手動編寫.js格式的文件，耗時長，增大開發人員的工作量，降低API注釋的效率。

發明內容

鑒于上述問題，提出了本發明以便提供一種注釋說明的生成方法及裝置，主要目的是解決代碼文件中的注釋更改后，需要人為修改注釋文件的問題。

借由上述技術方案，本發明提供的一種注釋說明的生成方法，包括：

讀取源代碼文件；

從所述源代碼文件中獲取接口注釋信息及接口調用信息，所述接口注釋信息包括接口功能注釋信息及接口參數注釋信息，所述接口調用信息包括接口調用參數信息及接口調用類型信息；

定義多個用于存儲信息的變量；

將所述接口注釋信息及所述接口調用信息分別存儲在對應的變量中；

根據存儲在變量中的接口注釋信息及接口調用信息，以及預置注釋轉換規則生成所述源代碼文件對應的注釋說明文件。

可選的，所述將所述接口注釋信息及所述接口調用信息分別存儲在對應的變量中包括：

將所述接口注釋信息中不同功能的接口功能注釋信息、以及不同名稱的接口參數注釋信息分別存儲在不同的變量中；

將所述接口調用信息中不同類型的接口調用類型信息、以及不同名稱的接口調用參數信息分別存儲在不同的變量中。

可選的，所述將所述接口調用信息中不同類型的接口調用類型信息、以及不同名稱的接口調用參數信息分別存儲在對應的變量中之后，所述方法還包括；

接收不同類型的接口調用類型信息對應的接口調用返回類型信息；

根據所述接口調用返回類型信息生成數據返回格式信息；

將所述數據返回格式信息存儲在對應的變量中。

可選的，所述根據存儲在變量中的接口注釋信息及接口調用信息，以及預置注釋轉換規則生成所述源代碼文件對應的注釋說明文件包括：

將存儲在對應變量中的所述接口參數注釋信息、所述接口調用參數信息、所述接口功能注釋信息、所述接口調用參數信息以及所述數據返回格式，按照注釋轉換規則進行拼接，并配置在所述預置注釋轉換規則對應的參數中，得到所述源代碼文件對應的注釋說明文件。