dotnet/roslyn

Intellisense tooltip fails to show inherited documentation with inline inheritdoc path

Ouverte

#52 476 ouverte le 7 avr. 2021

 (2 commentaires) (1 réaction) (0 personne assignée)C# (4 257 forks)batch import
Area-IDEConcept-Design DebtDeveloper CommunityIDE-IntelliSenseIntelliSense-Quick Infohelp wanted

Métriques du dépôt

Stars
 (20 414 étoiles)
Métriques de merge PR
 (Merge moyen 6j 17h) (256 PRs mergées en 30 j)

Description

This issue has been moved from a ticket on Developer Community.


I'm really rejoicing in Intellisense support for inheritdoc tags. However, there seems to be a combination of features which are not currently supported.

I have been authoring inheritdoc comments adhering to the SHFB documentation of inline inheritance rules, including some occurrences using a path query.

Intellisense should correctly show such inherited documentation.

However, Intellisense doesn't show any inherited documentation.

This sample originates from the SHFB documentation.

/// <summary>
/// A base class from which to inherit documentation
/// </summary>
/// <remarks>
/// <para>These remarks are for the base class.</para>
///
/// <para>This information applies to all classes that derive from
/// <see cref="BaseInheritDoc"/>:
/// <list type="bullet">
/// <item><description>Point #1.</description></item>
/// <item><description>Point #2.</description></item>
/// <item><description>Point #3.</description></item>
/// </list>
/// </para>
/// </remarks>
/// <conceptualLink target="86453FFB-B978-4A2A-9EB5-70E118CA8073" />
public class BaseInheritDoc {
}

/// <summary>
/// This is a derived class with inherited documentation.
/// </summary>
/// <remarks>This will inherit just the last &lt;para&gt; tag from
/// the base class's &lt;remarks&gt; tag:
/// <inheritdoc path="para[last()]" />
/// <inheritdoc path="/remarks/para[last()]" />
/// </remarks>
/// <conceptualLink target="86453FFB-B978-4A2A-9EB5-70E118CA8073" />
public class DerivedClassWithInheritedDocs : BaseInheritDoc
{
}

I have doubled the inheritdoc tag in order to outline a work around.

The current behavior is shown in this screenshot: ! [Screenshot 2021-04-06 114711.JPG] (https://aka.ms/dc/image?name=B59bc935f3bd440dbae2300fd10221b92637533035434553189_Screenshot_2021-04-06_114711.JPG&tid=59bc935f3bd440dbae2300fd10221b92637533035434553189) Actually, the bullet list should occur twice.


Original Comments

Feedback Bot on 4/6/2021, 07:01 PM:


Original Solutions

Christian Marrocco solved on 4/6/2021, 04:16 AM, 0 votes:

Guide contributeur