このブログは、旧・はてなダイアリー「檜山正幸のキマイラ飼育記 メモ編」(http://d.hatena.ne.jp/m-hiyama-memo/)のデータを移行・保存したものであり、今後(2019年1月以降)更新の予定はありません。

今後の更新は、新しいブログ http://m-hiyama-memo.hatenablog.com/ で行います。

ドキュメンテーションコメント内の見出し

ドキュメンテーションコメント内に、Markdownの見出しを入れられるが、そのレベルをいくつにするのが良いか? まだ結論は出てない。

それと、ヘッダ側からのドキュメンテーションコメントと実装側からのドキュメンテーションコメントを分けたい。今は水平線で分けている。

[追記]

doxygen自体がh2を使うので、文書構造の観点からはh3から下をドキュメンテーションとして使えばいい。だけど、h3が目立ちすぎるようにも感じる。見た目からだと、h4から先でもいいかも知れない。

[/追記]