我正在记录我在C#中编写的一些处理解析令牌的方法.由于系统其他领域的一些技术限制,这些令牌需要采用XML元素的形式(即<tokenName />).我想将这些令牌的格式放在摘要语句中.
但是,这会引发错误:格式错误 - 名称以无效字符开头".是否有任何类型的转义字符序列可用于在我的C#摘要注释中嵌入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>
/// LESS_THAN if arg1 <----
/// </returns>
private static Inequality Compare(uint arg1, uint arg2)
Run Code Online (Sandbox Code Playgroud)
我想将文字不等式符号放在箭头所在的位置,而不会触发XML解析器。我怎样才能做到这一点?
我使用了以下XML评论,
/// <example>
/// This example shows how to use <see cref="SampleCollection"/> property.
/// <code>
/// class TestClass
/// {
/// List<string> collection = new List<string>();
/// collection.Add("Column1");
/// collection.Add("Column2");
/// this.SampleCollection = collection;
/// }
/// </code>
/// </example>
public List<string> SampleCollection
{
get;
set;
}
Run Code Online (Sandbox Code Playgroud)
但它有以下警告错误,
关于'SampleCollection'的XML注释格式错误 - '结束标记'代码'与开始标记'字符串'不匹配.
因为List定义有<string>.所以它认为是XML标签.
有什么方法可以解决这个问题吗?
在 C# 源文件中编写 XML 文档注释时,是否需要替换"为"?这个问题讨论如何替换字符,但除了确定尖括号确实需要替换之外,没有确定哪些字符需要替换。