見出し画像

🛠️Doxygenのコメントの違い

special comment block ベースはあくまでもC++のコメントブロック

CまたはC++スタイルのコメント・ブロックにいくつかの追加マークを付けたもので、doxygenはそれが生成されるドキュメントで終わる必要のある構造化テキストの一部であることを認識します。

Python、VHDL、Fortranのコードにはそれぞれ異なるコメント付けの規則があり、それはそれぞれComment blocks in Python、Comment blocks in VHDL、Comment blocks in Fortranのセクションで見ることができます。

コード内の各エンティティには、2種類(場合によっては3種類)の記述があり、それらが一緒になってそのエンティティのドキュメントを形成しています。

JAVADOCスタイルでも書ける

JAVADOC_BANNERをオンにすると、JAVAじゃなくてもJAVADOCっぽいコメントにできます。

MarkDownも使える

LexインサイドYaccもちょびっと

DoxygenはC++で書かれており、約30万行のソースコードで構成されています。字句解析には、標準ツールのLex(またはそれに代わるFlex)が、約35,000行のlexスクリプトを介して実行されます。構文解析ツールのYacc(またはそれに代わるBison)も使用されていますが、細かい作業にのみ使用され、言語解析の大部分はネイティブのC++コードで行われています。ビルドはCMakeをベースとし、Pythonスクリプトもいくつか使用しています。

お願い致します