sql - 如何产生对 PLSQL 包、过程或函数的理解？

Question

我们可以在SQL Developer中生成ER图，这有助于我们更好地理解表。

像这样我们是否可以生成某种文档来概述包/过程/函数正在做什么？

我问这个问题是因为在我的项目中，我们有很长的包，例如 10000 行，并且读取它们会花费大量时间。如果我们能够生成某种文档对于理解将会非常有帮助。

Answer 1

就我的经验而言，没有可用的工具可以从 PLSQL 代码生成文档(只需阅读没有任何注释的代码)。

但是，我想提一下以下工具，如果它们有任何帮助，您可以考虑使用它们。

Pldoc

Pldoc 是一个开源实用程序，用于生成用 Oracle PL/SQL 编写的代码的 HTML 文档。

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

但是，您必须以 PLdoc 风格在包和函数中提供注释，以确保创建文档。

Toad 的 Code 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/

适用于多种编程语言的开源文档生成器。