sql - Pl/SQL 包内联文档

Question

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

Answer 1

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

我建议您尝试 PlDoc，然后调整不满足您需求的任何内容。设置不需要那么长时间，因此尝试它并不是一个巨大的时间投资。

Answer 2

我已经使用NaturalDocs 几年了，发现它易于安装和使用。它很像 JavaDocs 并且支持多种语言，尽管我只在 PL/SQL 中使用过它。非常可配置，虽然我没有发现有必要摆弄它。