有没有人知道如何在摘要注释中插入换行符,以便在Intellisense文档中反映换行符?
为了澄清,假设代码文档..
/// <summary>
/// Some text documentation
/// - a line break -
/// Some more documentation
/// </summary>
public void SomeMethod() { }
Run Code Online (Sandbox Code Playgroud)
因此,当使用此方法时,Intellisense提供了这样格式化的方法的摘要:
一些文字文件
更多文档
(注意 - 'para'标签不会创建空换行符 - 我已经尝试过了!)
我正在尝试在VB.Net中的XML注释中添加换行符.我读过另外两篇关于C#的帖子,
但建议<para>或<br/>标签不起作用.这个,
''' <summary>
''' <para>Line one</para><br />
''' <para>Line two</para><br />
''' </summary>
''' <value></value>
''' <returns></returns>
''' <remarks></remarks>
Public Property Speed As Double
Run Code Online (Sandbox Code Playgroud)
仍然看起来像这样:

我怎样才能做到这一点?
我目前正在记录我的 C# 代码,并发现包含一个直接显示应如何调用一段代码的代码块很有用。我使用<code>嵌入到摘要中的标签:
虽然这通常有效,但我想保留空白(换行符、缩进)。到目前为止我尝试了以下操作:
xml:space="preserve"属性应用于<code>标签,但这根本没有效果。<br />指示单独的新行(这在 VS 2019 中有效),但我无法插入空格或制表符。我尝试使用 (用于空格)和	(用于选项卡),但弹出窗口不会显示这些。CDATA部分,但之间的代码根本没有显示。有什么方法可以保留 C# XML 注释的代码标签中的空白吗?提前谢谢你的帮助。
我想添加一个多行XML文档,当我的鼠标悬停在它上面时,它会出现在Intelli-Sense气泡中.参见例如:
当我使用Visual Studio 2015时,以下代码有效(请参见下面的屏幕截图),但现在当我使用Visual Studio 2017时,它不再起作用了:
请参阅VS2015和VS2017中的以下屏幕截图
VS2015:
VS2017:
搜索stackoverflow和其他网站后,我尝试了一些代码,但它仍然无法正常工作.
// My failed guesses
/// This also does not work
/// & This does not work
let EXAMPLE3 = 2.0
/// This also does not work
/// \n This does not work
let EXAMPLE4 = 2.0
/// This also does not work
/// <br> This does not work
let EXAMPLE5 = 2.0
/// <summary>
/// This also does not work
/// <para> This does not work </para>
/// …Run Code Online (Sandbox Code Playgroud) 如果您将鼠标悬停///<summary></summary>在 VS17 (15.6.2) 中具有xml 文档 ( ) 的某些内容(类、方法等)上,您会看到这个小弹出窗口,其中显示了正确格式化的注释。
我试图列出一个清单(从这里复制):
/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </summary>
Run Code Online (Sandbox Code Playgroud)
但是弹出窗口只在一行中显示它:
Here is an example of a bulleted list: Item 1. Item 2.
Run Code Online (Sandbox Code Playgroud)
我也尝试添加<term>它(就像这里),但我得到的只是:
我也试过其他type的(也没有),但没有改变。这是一个错误吗?我如何解决它?