sql - PL/SQL 包内联文档

Question

我试图将我们的数据库包更完整地记录为 API。我们想要的是类似于 PL/SQL 的 JavaDocs。我已经看到了一些工具(pldoc、plsqldoc)，但想从使用它们的人那里了解它们是如何比较的。

Answer 1

我使用过 PlDoc 并发现它非常好。其他工具没用过，没法比较。我发现 PlDoc 在基础方面做得很好。我想要一些更高级的功能，所以我构建了我们自己的工具，为 PlDoc 添加了更多标签的扩展。此外，我不只是用它做文档，我还使用一些 PlDoc 标签(例如 @private)生成我们的包头。

我建议您尝试 PlDoc，然后调整不满足您需求的任何内容。设置不需要那么长时间，因此尝试它不需要花费大量时间。