DoxygenのMarkdownインラインマークアップ
Markdown形式のインラインマークアップはうまくいかないことが多い。期待しないことにしよう。
- ネイティブコマンド \b と HTMLタブ <b> は等価。
- ネイティブコマンド \em と HTMLタブ <em> は等価。
- ネイティブコマンド \p, \c と HTMLタブ <tt> は等価(タイプライター体)。
- ネイティブコマンド \n と HTMLタブ <br> は等価。
よって、HTMLタグ b, em, tt, br を使うことにする。。<b>はセマンティックじゃないが、strongの意味として使う。見た目の感じから b > em の順で使おう。
他に、
- インラインのコード範囲はバッククォートが使える。
- インラインのURL参照は <URL> が使える。
次の文字はエスケープが必要。
- \\
- \@
- \& HTML実体参照と誤解するから
- \<
- \>
逆の不等号 > もエスケープする必要がある。以下はDoxygenが使っている特殊文字。
- \$
- \#
- \%
エスケープはけっこう忘れる。エラーではないので、間違い検出が難しい。