如何生成对PLSQL包,过程或函数的理解?

时间:2016-06-09 06:58:03

标签: sql oracle oracle-sqldeveloper

我们可以在SQL开发人员中生成ER图,帮助我们以更好的方式理解表。

像这样我们是否有可能生成某种文档,可以让我们概述一个包/过程/函数在做什么?

我问这个是因为在我的项目中,我们有很长的包,比如10000行,阅读它们会耗费大量时间。如果我们能够生成某种文档以供理解,那将非常有帮助。

3 个答案:

答案 0 :(得分:2)

就我的经验而言,没有可用的工具可以用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 Doc插件 https://www.allroundautomations.com/plsplsqldoc.html

与PLdoc类似。

自然文档

http://www.naturaldocs.org/

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

答案 1 :(得分:1)

没有灵丹妙药 - 您无法自动创建代码文档。 更糟糕的是 - &#34; auto-doc&#34;工具通常会查看注释,但不保证注释与代码匹配。

但是,"working with legacy code"是一个常见问题。您可能希望阅读此答案及其引用的书。

答案 2 :(得分:0)

我对这个(新)工具感到满意:https://github.com/teotiger/pldocu

这是有限的,我想念一些自动导出格式(例如html),但你可以尝试自己做。对我来说没关系。

相关问题