如何理解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"是一个常见问题。你可能想阅读这个答案，以及它所指的书。