C#XML注释中的转义尖括号
我正在编写一个带有以下签名的简单比较函数:C#XML注释中的转义尖括号,c#,.net,visual-studio-2010,comments,xml-comments,C#,.net,Visual Studio 2010,Comments,Xml Comments,我正在编写一个带有以下签名的简单比较函数: /// <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 o
/// <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注释看起来特别漂亮,但我通常会尝试让我的注释在对象浏览器窗口中生成好看的注释,并且是智能化的,而不必担心它们在源代码中的外观。因此,我可能会这样写你的方法和评论:
/// <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"/>
/// < <paramref name="arg2"/>
/// </para><para>
/// GREATER_THAN iff <paramref name="arg1"/>
/// > <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()
//
///将两个无符号整数强制转换为有符号整数
///并对它们进行了比较
///
///不等式的左侧
///不平等的右侧
///
///小于iff
///
///
///大于iff
///
///
///等于iff
/// ==
///
私有静态不等式比较(
单元arg1、单元arg2)
{
var int1=(int)arg1;
var int2=(int)arg2;
返回int1int2
不平等性大于
:不等式。等于;
}//结束:比较()
在对象浏览器窗口中,此方法的文档如下所示:
/// <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"/>
/// < <paramref name="arg2"/>
/// </para><para>
/// GREATER_THAN iff <paramref name="arg1"/>
/// > <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()
私有静态…程序。不平等比较(uintarg1,uintarg2)
……计划成员
摘要:
将两个无符号整数强制转换为有符号整数,然后
比较他们
参数:
arg1:不等式的左侧
arg2:不等式的右侧
返回:
小于iff arg1
大于iff arg1>arg2
等于iff arg1==arg2
我作弊。我使用以下字符:≪≫
/// <returns>
/// if arg1 ≪ 0 then return Inequality.EQUAL_TO
/// if arg2 == 2 ...etc
/// </returns>
//
///如果arg1≪ 0,然后将不等式.EQUAL_返回到
///如果arg2==2…等
///
也适用于
/// <summary>
/// Checks if the List ≪ Dictionary ≪ int,string≫ ≫ is valid
/// </summary>
//
///检查列表是否正确≪ 字典≪ 整数,字符串≫ ≫ 有效
///
在intellisense、您的代码和VS生成的文档中看起来都不错
我保留了一个代码段,它生成以下行
//≪≫ ⇒ ◄==► ―― ≤ ≥ ... 再加上一些其他的特色菜可能是重复的。。。“C#XML注释中的转义尖括号
”,在问题正文中,如果arg1