search

dotnet / project-system

The .NET Project System for Visual Studio
MIT License
969 stars 389 forks source link

Show tooltip with project description in Solution Explorer #9134

Open janseris opened 1 year ago

janseris commented 1 year ago

Summary

Add tooltip with custom text for C# project in Visual Studio on mouse over. image

Editing: via rightclick Project -> Properties

image

User Impact

Documentation for new readers in the VS solution.

drewnoakes commented 1 year ago

Triage notes: We really like this idea. It'll require work across a few teams and needs to be prioritised.

cc @mckennabarlow

drewnoakes commented 1 year ago

It probably makes sense to reuse the existing <Description> MSBuild property for this. That's used for NuGet package descriptions and binds to the assembly description by default.

If we opt for a richer tool tip, we could show various bits of information in addition to the description:

Doing that would require a custom control in the tool tip, which is possible via the Solution Explorer APIs, but not easily expressed via hierarchy properties (unless the hierarchy provider learns to do this). It might make sense for the hierarchy attached collection source to have a callback that we can export to provide the tool tip when needed.

See ITreeDisplayItem.ToolTipContent. I believe we can provide a WPF UI element here for custom tool tip content.

drewnoakes commented 1 year ago

This kind of tooltip could also be useful on NuGet packages, which commonly contain description metadata.