相关疑难解决方法(0)

为Intellisense的注释添加换行符

有没有人知道如何在摘要注释中插入换行符,以便在Intellisense文档中反映换行符?

为了澄清,假设代码文档..

/// <summary>
/// Some text documentation
///  - a line break - 
/// Some more documentation
/// </summary>
public void SomeMethod() { }
Run Code Online (Sandbox Code Playgroud)

因此,当使用此方法时,Intellisense提供了这样格式化的方法的摘要:

一些文字文件

更多文档

(注意 - 'para'标签不会创建空换行符 - 我已经尝试过了!)

.net intellisense intellisense-documentati

77
推荐指数
4
解决办法
3万
查看次数

VB.NET和Visual Studio Intellisense中的多行XML注释

我正在尝试在VB.Net中的XML注释中添加换行符.我读过另外两篇关于C#的帖子,

C#中的XML多行注释 - 我做错了什么?

为Intellisense的注释添加换行符

但建议<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)

仍然看起来像这样:

在此输入图像描述

我怎样才能做到这一点?

vb.net intellisense visual-studio-2010 xml-comments

15
推荐指数
1
解决办法
4363
查看次数

有什么方法可以保留 C# XML 注释中的空白吗?

我目前正在记录我的 C# 代码,并发现包含一个直接显示应如何调用一段代码的代码块很有用。我使用<code>嵌入到摘要中的标签:

C# XML 注释摘要中嵌入的代码块

虽然这通常有效,但我想保留空白(换行符、缩进)。到目前为止我尝试了以下操作:

  • 我将该xml:space="preserve"属性应用于<code>标签,但这根本没有效果。
  • 我曾经<br />指示单独的新行(这在 VS 2019 中有效),但我无法插入空格或制表符。我尝试使用&#x20;(用于空格)和&#x9;(用于选项卡),但弹出窗口不会显示这些。
  • 我尝试使用一个CDATA部分,但之间的代码根本没有显示。

Br 标签有效,但解析器会忽略空格和制表符

有什么方法可以保留 C# XML 注释的代码标签中的空白吗?提前谢谢你的帮助。

c# comments xml-comments

10
推荐指数
1
解决办法
3340
查看次数

F#XML多行文档,Visual Studio 2017

我想添加一个多行XML文档,当我的鼠标悬停在它上面时,它会出现在Intelli-Sense气泡中.参见例如:

在此输入图像描述

当我使用Visual Studio 2015时,以下代码有效(请参见下面的屏幕截图),但现在当我使用Visual Studio 2017时,它不再起作用了:

请参阅VS2015和VS2017中的以下屏幕截图

VS2015:

在此输入图像描述

VS2017:

在此输入图像描述

搜索stackoverflow和其他网站后,我尝试了一些代码,但它仍然无法正常工作.

// My failed guesses    

/// This also does not work
/// &amp; &#10; 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> &#13; This does not work </para>
/// …
Run Code Online (Sandbox Code Playgroud)

xml f# visual-studio

7
推荐指数
1
解决办法
310
查看次数

Visual Studio 2017:&lt;list&gt; 在悬停时未正确显示(xml 文档)

如果您将鼠标悬停///<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的(也没有),但没有改变。这是一个错误吗?我如何解决它?

c# xml-comments visual-studio visual-studio-2017

5
推荐指数
1
解决办法
299
查看次数