Comment-based help in PowerShell - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

What is the output of Get-Help for this function?

Given the following PowerShell function with comment-based help, what will Get-Help Get-Greet display under the DESCRIPTION section?

PowerShell

function Get-Greet {
<#
.SYNOPSIS
Returns a greeting message.
.DESCRIPTION
This function returns a friendly greeting message to the user.
.PARAMETER Name
The name of the person to greet.
.EXAMPLE
Get-Greet -Name "Alice"
#>
param(
  [string]$Name
)
"Hello, $Name!"
}

A This function returns a friendly greeting message to the user.

B Returns a greeting message.

C The name of the person to greet.

D Get-Greet -Name "Alice" returns: Hello, Alice!

💡 Hint

Look for the .DESCRIPTION section inside the comment-based help block.

The .DESCRIPTION section in comment-based help provides a detailed explanation of what the function does. Get-Help shows this text under DESCRIPTION.

📝 Syntax

intermediate

Which comment-based help block is correctly formatted?

Which of the following comment-based help blocks will PowerShell recognize correctly for a function?

A

<##
.SYNOPSIS
Shows current date
#>

B

<#
.SYNOPSIS
Shows current date
#>>

C

<#
.SYNOPSIS
Shows current date
#>

D

<##
.SYNOPSIS
Shows current date
#>>

💡 Hint

Comment-based help blocks start with <# and end with #> exactly.

PowerShell comment-based help blocks must start with <# and end with #>. Using <## or #>> is invalid syntax.

🔧 Debug

advanced

Why does Get-Help not show the .PARAMETER section?

This function has comment-based help, but Get-Help does not show any parameter information. What is the likely cause?

PowerShell

function Test-Param {
<#
.SYNOPSIS
Test function
.PARAMETER Name
The name parameter
#>
param(
  [string]$Name
)
"Hello, $Name"
}

A The comment-based help block is missing the closing #> delimiter.

B The comment-based help block must use <## ... #> delimiters.

C The .PARAMETER section is misspelled and should be .PARAMETERS.

D The comment-based help block must be placed immediately before the param() block.

💡 Hint

Check the position of the comment-based help block relative to the param block.

For PowerShell to associate comment-based help with parameters, the help block must be immediately before the param() block without any blank lines or code in between.

🚀 Application

advanced

How to add examples in comment-based help?

You want to add two examples to your function's comment-based help. Which format correctly adds multiple examples?

A

<#
.EXAMPLE
Get-Data -Id 1
.EXAMPLE
Get-Data -Id 2
#>

B

<#
.EXAMPLE
Get-Data -Id 1
#>
<#
.EXAMPLE
Get-Data -Id 2
#>

C

<#
.EXAMPLES
Get-Data -Id 1
Get-Data -Id 2
#>

D

<#
.EXAMPLE
Get-Data -Id 1
Get-Data -Id 2
#>

💡 Hint

Each example uses its own .EXAMPLE section inside the same comment block.

PowerShell comment-based help supports multiple .EXAMPLE sections inside one comment block, each starting with .EXAMPLE.

🧠 Conceptual

expert

What happens if comment-based help is missing .SYNOPSIS?

If a PowerShell function's comment-based help block does not include a .SYNOPSIS section, what will Get-Help display for the synopsis?

A Get-Help will show the first line of the function code as the synopsis.

B Get-Help will display 'No synopsis available.'

C Get-Help will show an empty synopsis section.

D Get-Help will throw an error and not display help.

💡 Hint

Think about how PowerShell handles missing required help sections.

If .SYNOPSIS is missing, Get-Help shows 'No synopsis available.' as a placeholder.