dotnet/roslyn

Not allowed to resolve a type with an XML tag, until it fully closed

Open

#11,486 opened on May 21, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-CompilersBugConcept-Diagnostic Clarityhelp wanted

Description

  1. Given the following code, Ctrl+. at $
        /// <summary>
        ///     Returns a value indicating whether the current project has the specified capability
        /// </summary>
        /// <exception cref="ArgumentNullException$"
        bool Contains(string capability);

Expected: To be be offered to add "using System" to resolve ArgumentNullException Actual: Not offered

Need to completely close the XML tag before I'm allowed to resolve:

        /// <summary>
        ///     Returns a value indicating whether the current project has the specified capability
        /// </summary>
        /// <exception cref="ArgumentNullException"></exception>
        bool Contains(string capability);

This is a bit annoying, because completion doesn't close it for when you choose <exception from completion window.

Contributor guide

Tech stack
csharp
Domain
developer experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with C# XML doc commentsBasic understanding of Roslyn completion
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the completion provider for XML doc comments in Roslyn, specifically the handling of unclosed tags. Look at the file `src/Features/Core/Portable/Completion/Providers/XmlDocCommentCompletionProvider.cs` or similar. The issue suggests that completion is not triggered when the XML tag is not fully closed. Check how the completion context is determined and whether the tag closing is required. Consider modifying the logic to allow resolving types even when the tag is incomplete, possibly by examining the syntax tree for unclosed tags.