CやJavaなどのプログラム ソース中のコメントから,モジュール仕様書を書き出すツール。プログラムと文書を同時に管理できる。 コメントは記述形式が固定されており、そのとおりに従うと関数やデータ型、オブジェクトに関する定型的な文書が生成される。htmlやrtf, TeXのほかにmicrosoftのhtmlヘルプファイルなどを生成できる。
・目次 1.目的 2.Doxygenのダウンロード 3.Doxygenでドキュメント作成 4.Doxygenの書き方 5.Doxygenでドキュメント作成ファイル確認 関連記事 1.目的 ・DoxygenはソースファイルからJavadocに則ったコメントを使用することにより、ドキュメントの作成が出来る。 ・Doxygenのインストールとドキュメント作成プロセスについて説明する。 マニュアル:Doxygen 2.Doxygenのダウンロード ・Doxygenのダウンロード →Doxygen 上記公式ホームページのダウンロードから、Doxygenのダウンロードが出来る。 (Doxy…
(狭い視点ですが)DoxygenでPythonを扱うのは無理です。 検討条件 windows10 python3.7 doxygen1.9.5(2022/11/03にインストール) 検討結果 対象のpythonコード import sys def tasu(aa,bb): c = aa + bb return c d = tasu(10,20) if d > 5: print("d",d) else: sys.exit() 結果 call graphとか、でましぇーん。 設定とか javaを選ぶのがいいというウワサに従い。。。 そもそも、Pythonが選べないのが、つらすぎる。。。。 コメント…
bool を返す constexpr function 互換性の関係で引数を省略できない 実装的には、引数は使用せず常に false を返す C++11 の constexpr function なので (void)param; を置いて回避する手は使えない Doxygen に怒られるので仮引数の型だけ残して仮引数をコメントアウトする手は使えない という条件でどうやって compiler, Doxygen, cppcheck の警告を完全回避できるんだ…と思ったんだが、 世の中には同じことを既に解決している人が既に居た。 stackoverflow.com constexpr bool isf…
Doxygenについては、以下の検索をたどってみてください。 Doxygen by Google Doxygen by Bing 本当にこのような高度なレベルのドキュメント生成機能を"GNU General Public Licence"で使わせて頂いていいのかと平身低頭になる強力な解析支援ツールであります。 既に多くの方が使い方、Tipsなどをアップされているので、今さら私がなにかをお伝えするよりも、検索した情報の方が有用ではないでしょうか。 ちなみにですが、Doxygenにお世話になる場合というのが、以下のシチュエーションが多いのが私の実情であります。 基本設計書、機能設計書までは、利用者…