如何理解PLSQL包，過程或函數？

Question

我們可以在SQL開發人員中生成ER圖，這有助於我們更好地理解表。

像這樣有可能我們可以生成某種文件，它可以給我們一個包/程序/函數在做什麼的概述？

我在問這是因爲在我的項目中，我們有很長的包，比如10000行，讀取它們會消耗很多時間。如果我們能夠生成某種文件來理解它，將會非常有幫助。

Answer 1

就我的經驗而言，沒有可用於生成PLSQL代碼文檔的工具（僅通過閱讀代碼而沒有任何評論）。

但是，我想提及以下工具，如果他們有任何幫助，可以考慮使用它們。

Pldoc

Pldoc是用於生成的寫入的Oracle PL/SQL代碼的HTML文檔的開放源碼的工具。

http://pldoc.sourceforge.net/maven-site/

但是，你必須提供你的包註釋和功能PLdoc風格，以確保文件被創建。

蟾蜍的代碼的Xpert

http://www.toadworld.com/products/toad-for-oracle/w/toad_for_oracle_wiki/11088.code-complexity-analysis-using-toad

這個工具將您的代碼進行自動審覈，並出具報告。它還將提供一個您可能會覺得有用的CRUD矩陣。

PLSQL文檔插件 https://www.allroundautomations.com/plsplsqldoc.html

類似PLdoc。

自然文檔

http://www.naturaldocs.org/

開源文檔生成多種編程語言。

Answer 2

沒有銀彈 - 你不能自動創建代碼文檔。 更糟 - 「自動文檔」工具通常會查看評論，但不保證評論與代碼相匹配。

但是，"working with legacy code"是一個常見問題。你可能想閱讀這個答案，以及它所指的書。