[發明專利]項目描述文件優化方法、系統及存儲介質

在審

• 申請號: 202011561981.9
• 申請日: 2020-12-25
• 公開（公告）號: CN112527738A
• 公開（公告）日: 2021-03-19
• 發明（設計）人: 唐小妮
• 申請（專利權）人: 平安普惠企業管理有限公司
• 主分類號: G06F16/13
• 分類號: G06F16/13;G06F16/16
• 代理公司: 北京鴻元知識產權代理有限公司 11327
• 代理人: 王守梅;袁文婷

1.一種項目描述文件優化方法，應用于電子裝置，其特征在于，所述方法包括：

通過預先設置的腳本文件獲取并解析項目數據庫中的Markdown描述文件；其中，所述Markdown描述文件包括項目目錄結構信息；

根據所述Markdown描述文件的項目目錄結構信息生成目錄結構；

根據所述項目數據庫的項目根目錄讀取所述項目數據庫的文件目錄信息，并根據所述文件目錄信息和所述目錄結構獲得目錄樹形結構；

根據所述目錄結構和所述Markdown描述文件的項目目錄結構信息的對應關系，將所獲得的目錄樹形結構插入所述Markdown描述文件。

2.根據權利要求1所述的項目描述文件優化方法，其特征在于，所述預先設置的腳本文件為含有Markdown描述文件解析命令的shell腳本readme.sh。

3.根據權利要求1所述的項目描述文件優化方法，其特征在于，在通過預先設置的腳本文件獲取并解析項目數據庫中的Markdown描述文件步驟之前，還包括判定所述項目數據庫是否存在Markdown描述文件的過程；其中，

當判定所述項目數據庫中不存在Markdown描述文件時，所述腳本文件按照標準模板生成標準目錄結構；

根據所述項目數據庫的項目根目錄讀取所述項目數據庫的文件目錄信息，并根據所述文件目錄信息和所述目錄結構獲得目錄樹形結構；

將所述標準目錄結構和所獲得的目錄樹形結構組成Markdown描述文件。

4.根據權利要求1所述的項目描述文件優化方法，其特征在于，所述根據所述項目數據庫的項目根目錄讀取所述項目數據庫的文件目錄信息的方法包括：

通過find命令將所述項目數據庫的文件分為目錄文件和非目錄文件；

根據所述項目數據庫的項目根目錄遍歷所述目錄文件的文件夾以及文件夾下的文件；

獲取所述文件的文件類型和頂部注釋信息；

將所述文件夾、文件、文件類型和頂部注釋信息進行一一對應，獲得所述項目數據庫的文件目錄信息。

5.根據權利要求1所述的項目描述文件優化方法，其特征在于，所述Markdown描述文件的項目目錄結構信息包括項目目錄和項目目錄說明信息；其中，所述項目目錄說明信息與所述項目數據庫的文件的頂部注釋信息相對應；所述頂部注釋信息通過react-docgen提取獲得。

6.根據權利要求1所述的項目描述文件優化方法，其特征在于，在所述通過預先設置的腳本文件獲取并解析項目數據庫中的Markdown描述文件步驟之前，通過VS code鉤子實現對所述腳本文件的觸發調用。

7.一種項目描述文件優化系統，其特征在于，包括描述文件獲取單元、目錄結構生成單元、目錄樹形結構生成單元和描述文件優化單元；其中，

所述描述文件獲取單元，用于通過預先設置的腳本文件獲取并解析項目數據庫中的Markdown描述文件；其中，所述Markdown描述文件包括項目目錄結構信息；

所述目錄結構生成單元，用于根據所述Markdown描述文件的項目目錄結構信息生成目錄結構；

所述目錄樹形結構生成單元，用于根據所述項目數據庫的項目根目錄讀取所述項目數據庫的文件目錄信息，并根據所述文件目錄信息和所述目錄結構獲得目錄樹形結構；

所述描述文件優化單元，用于根據所述目錄結構和所述Markdown描述文件的項目目錄結構信息的對應關系，將所獲得的目錄樹形結構插入所述Markdown描述文件。

8.根據權利要求7所述的項目描述文件優化系統，其特征在于，還包括描述文件判定單元，所述描述文件判定單元，用于判定所述項目數據庫是否存在Markdown描述文件；

當判定所述項目數據庫中不存在Markdown描述文件時，所述腳本文件按照標準模板生成標準目錄結構；

根據所述項目數據庫的項目根目錄讀取所述項目數據庫的文件目錄信息，并根據所述文件目錄信息和所述目錄結構獲得目錄樹形結構；

將所述標準目錄結構和所獲得的目錄樹形結構組成Markdown描述文件。