手続き型プログラムのためのdoxygen.
-
17-09-2020 - |
質問
私は、よく文書化される必要がある大部分の主に手続き型のコードを持っています。これは一般に、特定の順序で実行されなければならないいくつかの機能を繰り返し使用することを含みます。
doxygenは素晴らしい製品ですが、OOPコードを文書化するために非常に指向しているようです。手続き作業を文書化するための自然な方法でDoxygenを使用する方法についてのヒントは誰でもありますか?
解決
Doxygenがうまくいっている方法について本質的にOOPは何もありません。それはそれがそれにより多くの情報を持っているので(例えば、継承グラフ)。
のために、OOコードに関するより多くの情報を抽出することができるだけです。私たちはPIGL CコードにDoxygenを使用していて、C ++と比較したときにPLAIN Cが提供していない情報をマイナスします。Doxygenのグループ化(@Addtogroup et al)機能を使用して、生成されたドキュメントを整理して、やるのがいいです。
所属していません StackOverflow