我今天意识到我不知道如何在C#的评论中转义字符.我想记录一个通用的C#类,但我不能写一个正确的例子,因为我不知道如何转义<
和>
字符.我一定要使用<
和>
?我不喜欢,如果是这样的话,因为我希望能够轻松阅读实际文档中的注释,因此我不必生成某种代码文档以便能够阅读示例代码.
我知道这可能是一个基本问题,但我似乎无法在任何地方找到答案.
我有这样的课
Table<T>
{}
Run Code Online (Sandbox Code Playgroud)
然后我有一些代码使用上面的类,我想评论我希望能够做类似的事情:
/// <summary>
/// blah blah blah Table<String>
/// </summary>
Run Code Online (Sandbox Code Playgroud)
但我不能在评论中使用尖括号,因为它认为它是一个标记,当帮助显示时它只是有一个关于没有结束标记的错误.
如何在Visual Studio中的注释中显示泛型类.
我正在用C#编写HTML解析器,并希望包含它在摘要XML块中处理的HTML示例.如何防止<和>字符搞乱Visual Studio 2008的自动文档?
例:
/// <summary>
/// Creates a FlowSegment based on an HTML code, i.e. <bold>
/// </summary>
/// <param name="code"></param>
/// <returns></returns>
public FlowSegment(string code)
{
Run Code Online (Sandbox Code Playgroud)
不幸的是,该示例导致此构造函数的工具提示显示(部分):
XML comment includes invalid XML
Run Code Online (Sandbox Code Playgroud)
而不是摘要评论.
如何逃避<和>字符?