「Doxygen」の版間の差分

→‎コード例: シンタックスハイライト
(公式サイトを更新。)
(→‎コード例: シンタックスハイライト)
以下のコード例は、Doxygenで文書生成可能な形式である。
 
<syntaxhighlight lang="c++">
/**
* The time class represents a moment of time.
*
*
* ''\author'' John Doe
*/
*/
'''class''' Time {
/**
* Constructor that sets the time to a given value.
* ''\param'' '''timemillis''' is a number of milliseconds passed since Jan 1. 1970
*/
Time(int timemillis);
/**
* ConstructorGet thatthe sets thecurrent time to a given value.
* ''\return'' A time object set to the current time.
* ''\param'' '''timemillis''' is a number of milliseconds passed since Jan 1. 1970
*/
static Time now('''int''' timemillis) {;
};
...
</syntaxhighlight>
}
/**
* Get the current time.
* ''\return'' A time object set to the current time.
*/
'''static''' Time now() {
...
}
};
 
コメント内に[[バックスラッシュ]]<code>\</code>または[[アットマーク]]<code>@</code>で始まる「特殊コマンド」<ref>[https://www.doxygen.nl/manual/commands.html Doxygen Manual: Special Commands]</ref>とその引数 (argument) を記述することで、プログラムソースコード中の各構成要素に対する説明を記述した定形的な文書を自動生成することができる。いくつかの特殊コマンドはJavadocとも互換性があるが、Doxygenでしか使えない独自のものも多い。