documentation - 手続き型プログラムのための Doxygen

Question

十分に文書化する必要がある、ほとんどが手続き型の大規模なコードがいくつかあります。これには通常、特定の順序で実行する必要がある多数の関数を繰り返し使用する必要があります。

Doxygen は素晴らしい製品ですが、OOP コードのドキュメント化を非常に重視しているようです。自然な方法で doxygen を使用して手続き型作業を文書化する方法に関するヒントはありますか?

Answer 1

doxygenの動作方法については本質的にOOPはありません。OOコードにはより多くの情報（継承グラフなど）が含まれているため、OOコードに関するより多くの情報を抽出できます。

プレーンCコードにはdoxygenを使用しており、C ++と比較した場合にプレーンCが提供しない情報を除いて、同様に機能します。doxygenのグループ化（@addtogroup et al）機能を使用して、生成されたドキュメントを整理するだけで、準備は完了です。