[發明專利]接口文檔顯示方法、裝置、存儲介質及電子設備

在審

• 申請號: 202111343076.0
• 申請日: 2021-11-12
• 公開（公告）號: CN113961239A
• 公開（公告）日: 2022-01-21
• 發明（設計）人: 周高鵬
• 申請（專利權）人: 中國工商銀行股份有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F9/451
• 代理公司: 北京康信知識產權代理有限責任公司 11240
• 代理人: 曾紅芳

本發明公開了一種接口文檔顯示方法、裝置、存儲介質及電子設備，主要涉及金融科技領域。其中，該方法包括：獲取目標程序的掃描信息，其中，上述掃描信息包括：注釋信息和代碼信息，上述注釋信息的掃描優先級高于上述代碼信息；基于上述掃描信息生成上述目標程序的接口文檔，其中，上述接口文檔至少包括目標注釋信息和目標代碼信息；顯示上述接口文檔，其中，在顯示上述接口文檔時，上述目標注釋信息的顯示優先級高于上述目標代碼信息。本發明解決了由于現有技術中的接口文檔顯示方法需要手動編寫大量的注釋與注解，造成的接口文檔顯示效率低且出錯率高的技術問題。

技術領域

本發明涉及金融科技領域，尤其涉及接口文檔處理技術領域，具體涉及一種接口文檔顯示方法、裝置、存儲介質及電子設備。

背景技術

在日常的java程序開發中，大部分開發者會更注重功能的開發，而忽視了接口文檔的編寫，但對于程序的調用方來說，一份好的接口文檔可以極大的提升開發效率，降低溝通成本。現有技術中的接口文檔顯示方法需要開發人員編寫大量的注釋與注解，代碼入侵太強，且出錯概率較高，接口文檔顯示效率較低，編碼人員工作的積極性也會因此受到影像。

針對上述的問題，目前尚未提出有效的解決方案。

發明內容

本發明實施例提供了一種接口文檔顯示方法、裝置、存儲介質及電子設備，以至少解決由于現有技術中的接口文檔顯示方法需要手動編寫大量的注釋與注解，造成的接口文檔顯示效率低且出錯率高的技術問題。

在日常的java程序開發中，大部分開發者會更注重功能的開發，而忽視了接口文檔的編寫，認為編寫接口文檔太浪費時間。其實，就像注釋是為了解釋代碼，方便自己或他人快速了解代碼，接口文檔也是為了讓別人更快地了我們的接口實現的功能。只不過注釋是針對的某一行或某一小段代碼，而接口文檔是針對整個方法或整個類做一個介紹，這樣使其他人不通過看具體的方法代碼就能快速了解類或方法的具體作用，提高代碼的可讀性。對于程序的調用方來說，一份好的接口文檔可以極大的提升開發效率，降低溝通成本。所以說編寫接口文檔是一件很重要也很有必要的事情，不過手動編寫接口文檔確實會花費很多時間去開發與維護，現有技術中的接口文檔顯示方法需要開發人員編寫大量的注釋與注解，代碼入侵太強，且出錯概率較高，接口文檔顯示效率較低，編碼人員工作的積極性也會因此受到影像。

針對上述問題，本發明實施例提供了一種接口文檔顯示方法，包括：獲取目標程序的掃描信息，其中，上述掃描信息包括：注釋信息和代碼信息，上述注釋信息的掃描優先級高于上述代碼信息；基于上述掃描信息生成上述目標程序的接口文檔，其中，上述接口文檔至少包括目標代碼信息；在上述接口文檔的上述目標代碼信息包含目標注釋信息時，則采用預定顯示方式顯示上述接口文檔，其中，上述預定顯示方式包括如下任意之一：在同時顯示上述目標代碼信息和上述目標注釋信息時，突出顯示上述目標注釋信息；在順序顯示上述目標代碼信息和上述目標注釋信息時，優先顯示上述目標注釋信息。

可選地，顯示上述接口文檔,包括:對上述接口文檔進行解析處理，得到應用程序接口名稱以及與上述應用程序接口名稱對應的應用程序接口信息；在顯示界面顯示菜單、以及上述應用程序接口信息，其中，上述菜單至少包括：一級菜單、以及二級菜單；上述一級菜單用于展示模塊名稱，上述二級菜單用于展示上述應用程序接口名稱。

可選地，對上述接口文檔進行解析處理，得到應用程序接口名稱,包括：判斷上述接口文檔中是否有與上述應用程序接口名稱對應的上述目標注釋信息；若判斷結果為是，則采用上述目標注釋信息作為上述應用程序接口名稱；若判斷結果為否,則采用預先設置的默認名稱作為上述應用程序接口名稱。

可選地，獲取目標程序的掃描信息之前，上述方法還包括：為上述目標程序配置應用程序接口類，并確定上述應用程序接口類的上述模塊名稱。

可選地，上述方法還包括，在上述顯示界面對上述菜單和上述應用程序接口信息進行編輯處理；在上述顯示界面對上述菜單進行排序處理。