sql - Pl/SQLパッケージのインラインドキュメント

Question

データベースパッケージをAPIとしてより完全に文書化しようとしています。私たちが欲しいのは、PL/SQL用のJavaDocsのようなものです。私はそこにいくつかのツール（pldoc、plsqldoc）を見てきましたが、それらを使用する人々からそれらがどのように比較されるか知りたいです。

Answer 1

私はPlDocを使用しましたが、本当に良いと思います。私は他のツールを使用したことがないので、比較することはできません。PlDocが基本をうまくやってくれたことがわかりました。より高度な機能が必要だったので、タグを増やすためにPlDocに拡張機能を追加する独自のツールを作成しました。また、ドキュメントを作成するだけでなく、いくつかのPlDocタグ（@privateなど）を使用してパッケージヘッダーを生成します。

PlDocを試してから、ニーズに合わないものを微調整することをお勧めします。セットアップにそれほど時間はかからないので、試してみるのに多大な時間の投資は必要ありません。

Answer 2

私はNaturalDocs を数年使用していますが、インストールと使用が簡単であることがわかりました。PL / SQLでしか使用していませんが、JavaDocsによく似ており、複数の言語をサポートしています。私はそれをいじる必要があるとは思いませんでしたが、非常に構成可能です。