如何生成对 PLSQL 包、过程或函数的理解?
How to generate understanding of PLSQL package, procedure or function?
我们可以在 SQL 开发人员中生成 ER 图,这有助于我们更好地理解表。
像这样我们是否可以生成某种文档,让我们了解 package/procedure/function 正在做什么?
我问这个是因为在我的项目中我们有很长的包,比如 10000 行,阅读它们会花费很多时间。如果我们可以生成某种文档以供理解,那将非常有帮助。
就我的经验而言,没有可用的工具可以从 PLSQL 代码中生成文档(只需阅读代码而不加任何注释)。
不过,我想提一下下面的工具,如果对你有帮助,你可以考虑使用它们。
Pldoc
Pldoc 是一个开源实用程序,用于生成用 Oracle PL/SQL 编写的代码的 HTML 文档。
http://pldoc.sourceforge.net/maven-site/
但是,您必须以 PLdoc 样式在包和函数中提供注释,以确保创建文档。
蟾蜍的代码专家
此工具将对您的代码执行自动审查并提供报告。它还将提供您可能会觉得有用的 CRUD 矩阵。
PLSQL 文档插件
https://www.allroundautomations.com/plsplsqldoc.html
类似于 PLdoc。
自然文献
用于多种编程语言的开源文档生成器。
没有灵丹妙药 - 您无法自动为代码创建文档。
更糟糕的是 - "auto-doc" 工具通常会查看注释,但不能保证注释与代码匹配。
但是,"working with legacy code" 是一个常见问题。您可能想阅读此答案及其引用的书。
我对这个(新)工具很满意:https://github.com/teotiger/pldocu
它的功能有限,我错过了一些自动导出格式(例如html),但您可以尝试自己做。对我来说没关系。
我们可以在 SQL 开发人员中生成 ER 图,这有助于我们更好地理解表。
像这样我们是否可以生成某种文档,让我们了解 package/procedure/function 正在做什么?
我问这个是因为在我的项目中我们有很长的包,比如 10000 行,阅读它们会花费很多时间。如果我们可以生成某种文档以供理解,那将非常有帮助。
就我的经验而言,没有可用的工具可以从 PLSQL 代码中生成文档(只需阅读代码而不加任何注释)。
不过,我想提一下下面的工具,如果对你有帮助,你可以考虑使用它们。
Pldoc
Pldoc 是一个开源实用程序,用于生成用 Oracle PL/SQL 编写的代码的 HTML 文档。
http://pldoc.sourceforge.net/maven-site/
但是,您必须以 PLdoc 样式在包和函数中提供注释,以确保创建文档。
蟾蜍的代码专家
此工具将对您的代码执行自动审查并提供报告。它还将提供您可能会觉得有用的 CRUD 矩阵。
PLSQL 文档插件 https://www.allroundautomations.com/plsplsqldoc.html
类似于 PLdoc。
自然文献
用于多种编程语言的开源文档生成器。
没有灵丹妙药 - 您无法自动为代码创建文档。 更糟糕的是 - "auto-doc" 工具通常会查看注释,但不能保证注释与代码匹配。
但是,"working with legacy code" 是一个常见问题。您可能想阅读此答案及其引用的书。
我对这个(新)工具很满意:https://github.com/teotiger/pldocu
它的功能有限,我错过了一些自动导出格式(例如html),但您可以尝试自己做。对我来说没关系。