Pl/SQL 包内联文档
我正在尝试将我们的数据库包更完整地记录为 API。我们想要的是类似于 PL/SQL 的 JavaDocs 之类的东西。我已经看到了一些工具（pldoc、plsqldoc），但想了解使用它们的人如何比较它们。
I am attempting to more fully document our database packages as an API. What we would like is something like JavaDocs for PL/SQL. I have seen a couple tools out there (pldoc, plsqldoc) but would like to know from people who use them how they compare.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
我使用过 PlDoc，发现它非常好。我没有使用过任何其他工具，所以无法进行比较。我发现 PlDoc 的基础知识做得很好。我想要一些更高级的功能，因此我构建了自己的工具，为 PlDoc 添加了扩展以获取更多标签。另外，我不只是用它做文档，我还使用一些 PlDoc 标签（例如 @private）生成包头。
我建议您尝试 PlDoc，然后调整任何不能满足您需求的内容。设置不需要那么长时间，因此尝试它并不需要投入大量时间。
I have used PlDoc and find it really good. I haven't used any other tools so can't compare. I found PlDoc did the basics well. I wanted some more advanced features so I built our own tool that added extensions to PlDoc for more tags. Also I don't just do documentation with it I also generate our package headers using some PlDoc tags (e.g @private).
I recommend you try PlDoc then tweak whatever doesn't meet your needs. It doesn't take that long to set up so its not a huge time investment to try it.
我已经使用 NaturalDocs 几年了，发现它很容易安装并使用。
它与 JavaDocs 非常相似，并且支持多种语言，尽管我只将它与 PL/SQL 一起使用。
非常可配置，尽管我没有发现有必要摆弄它。
I've been using NaturalDocs for a few years now and have found it easy to install and use.
It's pretty much like JavaDocs and supports multiple languages although I've only used it with PL/SQL.
Very configurable although I've not found it necessary to fiddle with that.