[發明專利]基于代碼的文檔自動生成方法、裝置、電子設備及介質

在審

• 申請號: 201811537830.2
• 申請日: 2018-12-15
• 公開（公告）號: CN109828783A
• 公開（公告）日: 2019-05-31
• 發明（設計）人: 姚娟娜
• 申請（專利權）人: 中國平安人壽保險股份有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73
• 代理公司: 深圳市賽恩倍吉知識產權代理有限公司 44334
• 代理人: 楊毅玲

本發明涉及計算機領域，具體涉及一種基于代碼的文檔自動生成方法、裝置、電子設備及介質。所述方法包括：檢查所述代碼文件是否有異常；在確認所述代碼文件無異常時從所述代碼文件中獲取代碼；從所述代碼中獲取用于處理流程的類的語句，確定所述用于處理流程的類的語句的順序流程；根據用于處理流程的類的語句的順序流程生成類的流程流轉圖；及根據所述類的流程流轉圖生成所述代碼文件對應的文檔。本發明能夠根據代碼生成流程圖，使得生成的文檔內容更加完善。

技術領域

本發明涉及計算機領域，具體涉及一種基于代碼的文檔自動生成方法、裝置、電子設備及介質。

背景技術

目前根據代碼生成文檔主要有兩種方式，一種是根據代碼注釋生成api文檔，另一種是根據類與類之間的關系生成類圖。然而，這兩種代碼生成方式比較獨立，缺乏對代碼邏輯的輸出以及相關負責人員的說明，不適用于程序員之間的技術文檔輸出。

發明內容

鑒于以上內容，有必要提出一種基于代碼的文檔自動生成方法、裝置、電子設備和計算機可讀存儲介質，以根據代碼生成流程圖，能夠使得生成的文檔內容更加完善。

本申請的第一方面提供一種基于代碼的文檔自動生成方法，所述方法包括：

檢查所述代碼文件是否有異常；

在確認所述代碼文件無異常時從所述代碼文件中獲取代碼；

從所述代碼中獲取用于處理流程的類的語句，確定所述用于處理流程的類的語句的順序流程；

根據用于處理流程的類的語句的順序流程生成類的流程流轉圖；及

根據所述類的流程流轉圖生成所述代碼文件對應的文檔。

優選地，所述方法還包括：

獲取所述代碼文件中的類；

識別所述代碼文件中所述類之間的繼承及引用關系；

根據所述類的繼承及引用關系生成類圖；及

根據所述類圖生成所述代碼文件對應的文檔。

優選地，所述方法還包括：

獲取所述代碼文件中的注釋信息；及

根據獲取的注釋信息生成所述代碼文件對應的文檔。

優選地，所述方法還包括：

識別所述代碼文件中代碼的程序語言調用關系；

生成相應的函數調用關系圖表；及

根據所述函數調用關系圖表生成所述代碼文件對應的文檔。

優選地，所述方法還包括：

根據所述代碼文件生成修改記錄；及

根據所述修改記錄生成所述代碼文件對應的文檔。

優選地，所述根據所述代碼文件生成修改記錄及根據所述修改記錄生成所述代碼文件對應的文檔包括：

根據代碼管理工具生成txt文檔的代碼修改記錄,使用Git命令獲取所述代碼文件中每一個代碼中的每一個分支上對應的用戶在過去設定時間內所進行的修改記錄，并將所有修改記錄存儲在一個txt文檔中；

使用python腳本，提取所述txt文檔中的數據輸入到所述文檔中。

優選地，所述檢查代碼文件是否有異常包括：

將所述代碼文件分為至少一個類別塊；