【问题标题】:Documentation Comments in C# - Can't use '<' or '>' in Summary [duplicate]C# 中的文档注释-不能在摘要中使用“<”或“>”[重复]
【发布时间】:2020-03-04 15:00:21
【问题描述】:

谁能告诉我如何让它工作?

 /// <summary>
 /// I want to write: List<T>
 /// </summary>

任何时候我使用 '' VS 都会放弃我... &lt;c&gt;&lt;code&gt; 不会成功。

【问题讨论】:

  • 这能回答你的问题吗? stackoverflow.com/questions/532166/…
  • @Matthew 那是专门针对&lt;see cref=""/&gt;的,这个问题不是
  • 到目前为止,您获得了几种不同的方法,并且两者都适用于您给出的示例。但是 IMO,如果您真的想参考,&lt;see cref=""/&gt; 更有意义一个特定的类。当然,如果您只想要文字 &amp;lt;&amp;gt;,那么 &amp;lt;&amp;gt; 方法几乎是唯一的选择(例如,如果您想说“检查 a > b”之类的话) .

标签: c# visual-studio comments


【解决方案1】:

您可以使用常规的 xml 转义:

 /// <summary>
 /// I want to write: List&lt;T&gt;
 /// </summary>

【讨论】:

    【解决方案2】:

    试试这个:

    /// <summary>
    /// I want to write: <see cref="System.Collections.Generic.List{T}"/>
    /// </summary>
    

    【讨论】:

    • 这扩展了肖恩的回答
    • @user947737:不是这样。这包括注释中的实际类型引用,而不是随机字符串。
    • @user947737 - 我不同意。这是一种完全不同的方法,应该作为一个单独的答案。他们解决了不同的问题,考虑到您的问题,这是 IMO 的适当方法。
    • @both:肖恩回答了我的问题,这是附加值 - 据我所知,扩展名!
    • 恕我直言,在这种特殊情况下,这是一个更好的答案。对于随机的 &lt;&gt;(或任何其他 xml 破坏字符),请使用 Sean 的答案中的 xml 实体。
    猜你喜欢
    • 2013-07-24
    • 2010-10-11
    • 2019-10-10
    • 1970-01-01
    • 2017-02-13
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-02-06
    相关资源
    最近更新 更多