转义C# XML注释中的尖括号

Question

我正在使用以下签名编写一个简单的比较函数：

  /// <summary>
  /// Casts two unsigned integers to signed integers and compares them
  /// </summary>
  /// <param name="arg1">Left side of inequality</param>
  /// <param name="arg2">Right side of inequality</param>
  /// <returns>
  /// LESS_THAN if arg1    <----
  /// </returns>
  private static Inequality Compare(uint arg1, uint arg2)

我想将文字不等式符号放在箭头所在的位置，而不触发XML解析器。我该怎么做？

Answer 1

如果您想在方法本身上面的文档中看到它，那么您就不能把它完整地写出来，它也会更清晰。

对于所有其他目的(如代码洞察力、生成的文档等)，可以使用文字

<

使用

>

比..。

Answer 2

我作弊。我使用以下字符：≪≫

/// <returns>
/// if arg1 ≪ 0 then return Inequality.EQUAL_TO
/// if arg2 == 2 ...etc 
/// </returns>

同样有用的

/// <summary>
/// Checks if the List ≪ Dictionary ≪ int,string≫ ≫ is valid
/// </summary>

在intellisense中，在代码中，在VS生成的文档中，看起来都很好。

我保留了生成以下行的代码片段

//◄==►≪≫⇒-≤≥.再加上其他一些特色菜

Answer 3

我同意您不能让原始XML注释看起来特别漂亮，但我通常尝试在对象浏览器窗口和IntelliSense中生成好看的评论，而不必担心它们在源代码中的外观。因此，我可能会编写您的方法并注释如下：

 /// <summary>
 /// Casts two unsigned integers to signed integers
 /// and compares them
 /// </summary>
 /// <param name="arg1">Left side of inequality</param>
 /// <param name="arg2">Right side of inequality</param>
 /// <returns><para>
 /// LESS_THAN iff <paramref name="arg1"/>
 /// &lt; <paramref name="arg2"/>
 /// </para><para>
 /// GREATER_THAN iff <paramref name="arg1"/>
 /// &gt; <paramref name="arg2"/>
 /// </para><para>
 /// EQUAL_TO iff <paramref name="arg1"/>
 /// == <paramref name="arg2"/>
 /// </para></returns>
 private static Inequality Compare(
       uint arg1, uint arg2)
 {
   var int1 = (int)arg1;
   var int2 = (int)arg2;
   return int1 < int2
     ? Inequality.LESS_THAN
       : int1 > int2
       ? Inequality.GREATER_THAN
         : Inequality.EQUAL_TO;
 }  // end: Compare()

在对象浏览器窗口中，该方法的文档如下所示：

私人静态.Program.Inequality arg1，uint arg2) .项目成员 摘要： 将两个无符号整数转换为有符号整数并进行比较。 参数： arg1:不等式的左侧 arg2:不等式的右边 返回： LESS_THAN当且仅当arg1 < arg2 GREATER_THAN当且仅当arg1 > arg2 EQUAL_TO iff arg1 == arg2