4

Doxygen コメントにリテラル HTML 要素を含めたい。このようなもの：

/// This function skips all <li> elements

そのように書くと<li>、HTML出力に渡されますが、これは明らかに私が望んでいるものではありません.

代わりに、次のように書くことができます。

/// This function skips all &lt;li&gt; elements

これは、Doxygen によって生成された HTML では正常に機能しますが、ソース コード自体のコメントはかなり判読しにくくなっています。

そのため、生成されたドキュメントとソース コードの読みやすさのどちらかを選択する必要があるようです。

それは本当にそうですか、またはDoxygenに自動的にすべてを強制的に変換させる方法はあり<blabla>ます&lt;blabla&gt;か?

4

1 に答える 1

9

以下を使用することもできます。

/// This function skips all \<li\> elements

または（場合MARKDOWN_SUPPORT=YES）書く：

/// This function skips all `<li>` elements

どちらも適度に読みやすいか、すべてを\verbatim..\endverbatimセクションに入れますが、そのようにレンダリングされます。

エイリアスを定義することもできます。

ALIASES = verb{1}="\<\1\>"

そして、書く

/// This function skips all \verb{li} elements
于 2013-05-01T17:50:35.893 に答える