11

DOxygen / Visual Studio互換のコメントを使用してメンバー関数を文書化しているとしましょう。コンパイラの警告を作成せずに、コードベースの可読性を維持しながら、「<」未満の記号を使用するにはどうすればよいですか？

たとえば、これを行った場合：

    /// <summary>
    /// Verifies x < y
    /// </summary>
    bool VerifyIsLessThan(float x, float y);

コンパイラは言う：

1>c:\MyProject\VerificationLib.h(246) : warning C4635: XML document comment applied to 'VerificationLib.VerifyIsLessThan(System.Single,System.Single)': badly-formed XML: Whitespace is not allowed at this location.

Doxygenで生成されたドキュメントだけでなく、コードベースでも読み取り可能なままにする方法でこれを回避する方法はありますか？

[編集]

これは、Doxygenではなく、VisualStudio側の問題に関係していると思い始めています。両方で機能するフォームを使用しています。元の質問で言及されている警告は、DoxygenではなくVisualStudioからのものです。

もう少し深く掘り下げると、逐語的に直接サポートされていないように見えますか？

4

4 に答える 4

8

使用するだけ\<で、それで十分です。 http://www.doxygen.nl/manual/commands.html#cmdlt

于 2012-09-14T14:00:37.237 に答える
3

コード または 逐語的に使用できます。

于 2012-09-14T14:26:36.023 に答える
2

<要約に文字をインライン化できるようにする唯一の方法はそうです&lt;が、インテリセンスとdoxygenが正常に見えても、実際のコードベースでは醜いように見えます...

于 2012-09-14T15:00:42.050 に答える
0

次のように、コメントをCDATAブロック内に配置することもできます。

<![CDATA[ Verifies x < y ]]>

本当に読みやすいと思うかどうかはわかりませんが、Jon Cageが指摘した、除算記号などと誤解される可能性のある問題を回避するのに役立ちます。

追加情報：

XMLの<！[CDATA []]>はどういう意味ですか？

http://forums.asp.net/t/1007641.aspx/1

于 2013-08-21T14:56:48.297 に答える