Pl / SQL包内联文档

Question

我正在尝试将我们的数据库包更全面地记录为API。我们想要的是像PL / SQL的JavaDocs。我已经看到了一些工具（pldoc，plsqldoc），但想知道使用它们的人如何比较。

Answer 1

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

我建议您尝试使用PlDoc然后调整任何不符合您需求的内容。设置并不需要很长时间，因此尝试它不是一个巨大的时间投入。

Answer 2

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