4

私はソフトウェア ライブラリの新しいドキュメントに取り組んでおり、Doxygen ベースの API リファレンスと一緒に DocBook で書かれるべきだと思う一般的なドキュメントをどのように組み合わせることができるか疑問に思っています。

Doxygen の部分は既に存在するのでそのままにしておくことを好みますが、DocBook を使用することは単なるアイデアであり、私はどんなアイデアも受け入れます。ドキュメント全体を Doxygen で書くことは可能ですが、それが最善の方法だとは思えません。

ありがとう!

4

1 に答える 1

1

すべての Doxygen の方法を再検討することをお勧めします。Doxygen を使用して精巧なドキュメントを作成することは、最初は面倒に思えるかもしれませんが、2 つのドキュメントの一貫性を維持することは、長期的にはより多くの作業になります。追加されたワークロードとは別に、両方の出力製品を組み合わせることによって得られます。

Doxygen を使用すると、Markdown ファイルをページとしてドキュメントに含めることができ (マニュアルのこのセクションを参照)、ソース ファイルが大きくなりすぎないように精巧なドキュメントを外部化できます (マニュアルのこのセクションを参照)。

また、私は Docbook を実際に使用したことがないので、少し Doxygen に傾倒しているかもしれません。

于 2014-02-10T11:14:49.770 に答える