Pl/SQL包內聯文檔

Question

我試圖更全面地將我們的數據庫包記錄爲API。我們想要的是像PL/SQL的JavaDocs。我已經看到了一些工具（pldoc，plsqldoc），但想知道使用它們的人如何比較。

Answer 1

我已經使用了PlDoc並且發現它確實不錯。我沒有使用任何其他工具，所以無法比較。我發現PlDoc做得很好。我想要一些更高級的功能，所以我建立了我們自己的工具，爲PlDoc添加擴展以獲得更多標籤。此外，我不只是做它的文檔，我也使用一些PlDoc標籤（例如@private）生成我們的包頭。

我建議你試試PlDoc，然後調整任何不符合你的需求的東西。建立這麼短的時間並不需要很長時間，所以它不需要花費大量時間進行嘗試。

Answer 2

我幾年來一直在使用NaturalDocs，並且發現它易於安裝和使用。 這與JavaDocs非常相似，並且支持多種語言，儘管我只是將它用於PL/SQL。 非常可配置，雖然我沒有發現它有必要擺弄。