Doxygen
概要 コマンド等 ( Doxygen コマンド・HTML タグ・XML コメント・マークダウン・設定 )
コメントブロック ( C / C++ / C# / Objective-C / PHP / Java Python VHDL Fortran Tcl )
概要
- Doxygen (汎用ドキュメントジェネレータ・コマンド仕様) のメモ
- このドキュメントの対象:Doxygen 1.8.20 (2020-8-24)
- ソースコードを解析しドキュメント化
- 対応言語:C++・C・Objective-C・C#・PHP・Java・Python・IDL (Corba・Microsoft・UNO/OpenOffice 風)・Fortran・VHDL
・Tcl1.8.18・D (ある程度) - 出力ドキュメント:HTML・LaTeX・RTF・PostScript・ハイパーリンク PDF・圧縮 HTML・Unix man ページ
- 他のツールを使用することで、クラス図・コラボレーション図・呼び出し関係図・UML図・シーケンスチャート・数式等の挿入が可能 (図の生成・挿入)
- 公式サイト (外部リンク)
- Doxygen (英語)
- Doxygen:Downloads (英語)
- 寄付:各ページの右上の [Donate] ボタン
コマンド等
コメントブロック
C / C++ / C# / Objective-C / PHP / Java
- 前置
- 【複数行コメント】
/** * コマンド等 */ 各種宣言 /*! * コマンド等 */ 各種宣言
- 【中間の * の省略】
/** コマンド等 */ 各種宣言 /*! コマンド等 */ 各種宣言
- 【単一行コメント】
/// /// コマンド等 /// 各種宣言 //! //! コマンド等 //! 各種宣言
- 【上記の応用】
/************************************** * コマンド等 **************************************/ 各種宣言 //////////////////////////////////////// /// コマンド等 //////////////////////////////////////// 各種宣言
- 【複数行コメント】
- 後置
各種宣言 /*!< コマンド等 */ 各種宣言 /**< コマンド等 */ 各種宣言 //!< コマンド等 各種宣言 ///< コマンド等
- 関連
Python
- 後置
- 【Python標準】
各種宣言 ''' Doxygenのコメントとして使用 1.8.20 (PYTHON_DOCSTRING = NO) ''' 各種宣言 ''' ドキュメンテーション文字列 (詳細として出力・Doxygenコマンド未サポート)【上記以外】 '''
- 【Python標準】
- 前置
- 【Doxygen準拠】
## コマンド等 # コマンド等 各種宣言
- 【Doxygen準拠】
- 関連
VHDL
- 前置
-
--! コマンド等 各種宣言
-
- 関連
Fortran
- 前置
- 【Doxygen準拠】
!> コマンド等 !! コマンド等 !! コマンド等 各種宣言 !> コマンド等 !> コマンド等 !> コマンド等 各種宣言 !< コマンド等 !! コマンド等 !! コマンド等 各種宣言 !< コマンド等 !> コマンド等 !> コマンド等 各種宣言
- 【Doxygen準拠】
- 関連
Tcl 1.8.18
- 前置
-
## コマンド等 # コマンド等 各種宣言
- 後置
各種宣言;#< コマンド等
-