Pl/SQL包内联文档

Question

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

Answer 1

我已经使用了PlDoc并且发现它确实不错。我没有使用任何其他工具，所以无法比较。我发现PlDoc做得很好。我想要一些更高级的功能，所以我建立了我们自己的工具，为PlDoc添加扩展以获得更多标签。此外，我不只是做它的文档，我也使用一些PlDoc标签（例如@private）生成我们的包头。

我建议你试试PlDoc，然后调整任何不符合你的需求的东西。建立这么短的时间并不需要很长时间，所以它不需要花费大量时间进行尝试。

Answer 2

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