dotnet/roslyn

Add support for href in xmldoc, as we have for cref and langword

Open

#25,671 opened on Mar 22, 2018

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

Description

cref When typing <see you get an automatic completion with cref=”” and the completion of symbols inside cref also works, and QuickInfo shows cref with proper symbol coloring:

langword If you edit what was typed above, there is also a completion for langword offered, the choices for langword are also offered (abstract, async, etc), and the langwords are displayed specially in QuickInfo.

href But when typing href instead, there is no completion for href="" and when displaying this documentation in the IDE, the href is treated as text (no colorization and no link).

href-quickinfo

Tagging @mairaw @BillWagner for additional Issue relates to https://github.com/dotnet/docs/issues/4176 Relates to https://github.com/dotnet/csharplang/blob/master/spec/documentation-comments.md

Contributor guide

Tech stack
csharp
Domain
documentation
Issue type
feature
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-2 days
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#Understanding of Roslyn XML doc handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding href support in XML documentation comments, similar to existing cref and langword. The implementation likely involves modifying the completion provider and QuickInfo display in the IDE. Relevant files may include those handling XML doc completion and semantic analysis. The existing handling for cref and langword can be used as a reference. There is a related csharplang specification link in the issue.