VS Intellisense:在悬停时显示INDENTED多行代码示例

时间:2020-07-30 17:53:14

标签: c# visual-studio intellisense xml-documentation

这样的事情可能吗?如果不清楚我在说什么,下面是一个详细的示例:

采用我几周前编写的快速实用程序类(详细信息省略)以及我要分享的示例:

public abstract class CommonOdinAttributesForOwnedType<TProperty, TParent> : OdinAttributeProcessor<TProperty>
{
    //snip
}

//EXAMPLE IMPLEMENTATION (Recommended to be nested inside MyBaseType):
protected class BoolAttributesInsideMyBaseType : CommonOdinAttributesForOwnedType<bool, MyBaseType>
{
    protected override List<Attribute> GetAdditionalAttributes()
    {
        return new List<Attribute>()
        {
            new ToggleLeftAttribute(), //add more desired attributes here
        };
    }
}

我在抽象类上方有以下XML:

/// <summary>
/// Gives ALL objects of type TProperty drawn within classes derived from TParent a requested list of 
/// Odin GUI attributes
/// <code>
/// //EXAMPLE IMPLEMENTATION (Recommended to be nested inside MyBaseType):
/// protected class BoolAttributesInsideMyBaseType : CommonOdinAttributesForOwnedType&lt;bool, MyBaseType&gt;
/// {
///     protected override List&lt;Attribute&gt; GetAdditionalAttributes()
///     {
///         return new List&lt;Attribute&gt;()
///         {
///             new ToggleLeftAttribute(), //add more desired attributes here
///         };
///     }
/// }
/// </code>
/// </summary>

现在,我可能会发誓,当我最初创建该类时,工具提示看起来像我想要的……但也许我正在产生幻觉。无论如何,在本周的重构过程中(在此过程中,文件被移动/重命名并通过ReSharper的清理进行馈送),我注意到Intellisense工具提示现在看起来像是垃圾:

Intellisense with zero whitespace control

在每行末尾添加<br/>只会有所帮助:

enter image description here

...而且我无法找到一种方法来手动指定缩进,就像<br/>指定换行一样。我还尝试了<remarks><example><para>的许多组合以及嵌套块的各种方法,但是没有任何效果。

因此:有没有办法(理想地)使Visual Studio 2019实际解析在XML文档<code></code>块中找到的空格,或者(禁止使用)其他一些手动添加缩进的块,就像我这样用<br/>手动添加了新行?我看了看又看,也找不到办法。

1 个答案:

答案 0 :(得分:1)

VS Intellisense:在悬停时显示INDENTED多行代码示例

恐怕您无法获得想要的东西。

实际上,vs xml文档无法保留代码样式格式。

summary xml node下,它无法保留代码格式。您必须手动更改格式。使用一些代码来更改显示的样式。

是否有任何方法(理想情况)使Visual Studio 2019实际解析 XML文档<code></code>块中找到空格

换行符可以使用<br/><para/>但是无法缩进第一行。 HTML格式设置方法,间距,空格等无效。

实际上,这是一个缺陷--vs的xml文档无法缩进行并保持代码样式。

到目前为止,我们只能做您所做的事情。

此外,如果您仍然想要此功能,可以our User Voice Forum suggest a feature使用,团队会仔细考虑您的问题,希望他们能给您满意的答复