You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Hover IntelliSense does not display comment-based help (Synopsis/Description) #5501
When hovering over a function call (or its definition) in a .ps1 script, the hover tooltip shows the function signature but does not display the comment-based help content (.SYNOPSIS, .DESCRIPTION, .PARAMETER).
Steps to Reproduce
Create a .ps1 file with a function that has comment-based help:
<#.SYNOPSIS Writes a colored line to the console..PARAMETERMessage The text to display..PARAMETERColor The foreground color to use.#>functionWriteColorLine([string] $Message, [ConsoleColor] $Color)
{
$prev= [Console]::ForegroundColor
[Console]::ForegroundColor =$Color
[Console]::WriteLine($Message)
[Console]::ForegroundColor =$prev
}
WriteColorLine "Hello" Cyan
Hover over WriteColorLine on the call site or the definition.
Expected Behavior
The hover tooltip should display the Synopsis, Description, and Parameter documentation from the comment-based help block (similar to how C# displays XML doc comments).
Actual Behavior
The hover tooltip only shows the function signature. No Synopsis or Description text is displayed.
Tested Placements
All valid comment-based help placements were tested with the same result:
Above the function keyword
Inside the function body (first statement, before param())
Inside the function body with param() block after the help comment
In all cases, Get-Help correctly displays the documentation when the script is dot-sourced, confirming the help syntax is valid.
Same underlying request as #1577 (surfacing comment-based help for functions); consolidating on the older canonical issue, which also covers the hover case.
Activity
JustinGrote commentedon Jun 3, 2026
Thanks for your submission! This is a known item we do want to address, it's a little tricky however.
andyleejordan commentedon Jun 16, 2026
Same underlying request as #1577 (surfacing comment-based help for functions); consolidating on the older canonical issue, which also covers the hover case.
🤖 Drafted by GitHub Copilot at Andy Jordan (@andyleejordan)'s request — pending maintainer review.