dotnet/roslyn

Clicking on Intellisense XML comment file-include tag should open the XML file in VS and show the specified path

Open

#44,697 opened on May 29, 2020

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C# (4,257 forks)batch import
Area-IDEIDE-Navigationhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

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

Visual Studio supports file-includes on C# XML comments. This is really nice. It would be even nicer, if you could click on the specified file name in the include-tag and be forwarded to that file (the file was opened in VS then) and to the specified path in that file, so that you directly are at the place where the included comment is defined. This would make editing much easier.

Original Comments

Visual Studio Feedback System on 5/28/2020, 03:11 AM:

Thank you for taking the time to provide your suggestion. We will do some preliminary checks to make sure we can proceed further. We'll provide an update once the issue has been triaged by the product team.

Contributor guide

Research direction
Investigate the Roslyn codebase to understand how XML documentation file includes are currently processed and how the editor handles navigation. Look for existing VS extensibility points for opening files from comments.
Tech stack
csharp
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
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.
Mostly clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25