Comment-based help in PowerShell - Mini Project: Build & Apply

Comment-based help

📖 Scenario: You are creating a PowerShell script that performs a simple task. To help others understand and use your script easily, you will add comment-based help. This is like writing instructions inside your script so anyone can see how to use it by typing Get-Help.

🎯 Goal: Build a PowerShell script with comment-based help that describes the script's purpose, syntax, parameters, and examples.

📋 What You'll Learn

Create a PowerShell script named Get-Greeting.ps1.

Add comment-based help with .SYNOPSIS, .DESCRIPTION, .PARAMETER, and .EXAMPLE sections.

Include a parameter called Name that accepts a string.

Write a simple script that outputs a greeting message using the Name parameter.

Display the help content using Get-Help.

💡 Why This Matters

🌍 Real World

Comment-based help is used in real PowerShell scripts and modules to provide users with clear instructions on how to use commands and scripts.

💼 Career

Knowing how to write comment-based help is important for system administrators, DevOps engineers, and anyone who writes PowerShell scripts professionally to improve script usability and maintainability.

1

Create the script with a Name parameter

Create a PowerShell script named Get-Greeting.ps1 with a parameter called Name that accepts a string. The script should output a greeting message using Name. Write the line: param([string]$Name) and a line that outputs "Hello, $Name!".

PowerShell

# Create a parameter called Name and output a greeting message
# Your code here

Hint

Use param([string]$Name) to declare the parameter. Use Write-Output to print the greeting.

2

Add the .SYNOPSIS and .DESCRIPTION sections

Add comment-based help at the top of the script with .SYNOPSIS describing the script as "Outputs a greeting message." and .DESCRIPTION describing it as "This script takes a name and prints a greeting message." Use the <# and #> comment block.

PowerShell

param([string]$Name)

Write-Output "Hello, $Name!"

Hint

Use a comment block starting with <# and ending with #>. Inside, add .SYNOPSIS and .DESCRIPTION lines.

3

Add the .PARAMETER and .EXAMPLE sections

Inside the comment-based help block, add a .PARAMETER Name section describing it as "The name of the person to greet." Then add an .EXAMPLE section showing how to run the script with -Name "Alice".

PowerShell

param([string]$Name)

Write-Output "Hello, $Name!"

Hint

Inside the comment block, add .PARAMETER Name and describe it. Then add .EXAMPLE with a usage example.

4

Display the help content using Get-Help

Run the command Get-Help .\Get-Greeting.ps1 in PowerShell to display the comment-based help you added.

PowerShell

# Run the command below in PowerShell
# Your code here

Hint

Type Get-Help .\Get-Greeting.ps1 in PowerShell to see your help content.

Practice

1. What is the main purpose of comment-based help in a PowerShell script?

easy

A. To provide instructions and details about the script for users

B. To make the script run faster

C. To encrypt the script content

D. To automatically fix script errors

Solution

1. Step 1: Understand what comment-based help is

   Comment-based help is written inside scripts as special comments to explain what the script does and how to use it.

2. Step 2: Identify the purpose of these comments

   The comments help users understand the script, not affect performance or security.

3. Final Answer:

   To provide instructions and details about the script for users -> Option A

4. Quick Check:

   Comment-based help = user instructions [OK]

Hint: Help comments explain script usage, not execution speed [OK]

Common Mistakes:

• Thinking help comments speed up scripts
• Confusing help with encryption
• Assuming help fixes errors automatically

2. Which of the following is the correct way to start a comment-based help block in PowerShell?

easy

A. <#

B. ##

C.

D. #>

Solution

1. Step 1: Recall PowerShell comment syntax

   PowerShell uses <# and #> to start and end block comments, which are used for comment-based help.

2. Step 2: Identify the correct start marker

   The block comment starts with <# and ends with #>. Other options are not valid for block comments.

3. Final Answer:

   <# -> Option A

4. Quick Check:

   Block comment start = <# [OK]

Hint: Block comments start with <# and end with #> [OK]

Common Mistakes:

• Using ## which is line comment, not block
• Confusing with HTML comments
• Using #> alone as start

3. Given this comment-based help snippet inside a script:

<#
.SYNOPSIS
Shows a greeting message
.PARAMETER Name
The name to greet
#>
function Greet-User {
  param([string]$Name)
  "Hello, $Name!"
}

What will Get-Help Greet-User display under the SYNOPSIS section?

medium

A. No help available

B. The name to greet

C. Hello, $Name!

D. Shows a greeting message

Solution

1. Step 1: Identify the SYNOPSIS section content

   The SYNOPSIS section contains the short description: "Shows a greeting message".

2. Step 2: Understand Get-Help output

   Get-Help shows the SYNOPSIS text exactly as written under that section.

3. Final Answer:

   Shows a greeting message -> Option D

4. Quick Check:

   SYNOPSIS text = Shows a greeting message [OK]

Hint: SYNOPSIS shows short script description in Get-Help [OK]

Common Mistakes:

• Confusing PARAMETER text with SYNOPSIS
• Expecting function output as help text
• Assuming no help shows by default

4. You wrote this comment-based help block but Get-Help shows no information:

#
.SYNOPSIS
Prints date
.PARAMETER Format
Date format string
#>
function Show-Date {
 param([string]$Format)
 Get-Date -Format $Format
}

What is the error preventing help from showing?

medium

A. PARAMETER section misspelled

B. Function name missing in help

C. Missing starting <# for block comment

D. No SYNOPSIS section present

Solution

1. Step 1: Check comment block delimiters

   The help block starts with # but must start with <# to be recognized as block comment.

2. Step 2: Understand Get-Help parsing

   Without <# at start, the help block is ignored, so no help shows.

3. Final Answer:

   Missing starting <# for block comment -> Option C

4. Quick Check:

   Block comment start missing = no help shown [OK]

Hint: Block comments must start with <# and end with #> [OK]

Common Mistakes:

• Using # instead of <# to start block comment
• Misspelling PARAMETER keyword
• Thinking function name is required in help block

5. You want to add comment-based help to a script with two parameters: Path (string) and Recurse (switch). Which is the correct way to document these parameters inside the help block?

hard

A. <#
.PARAMETER Path
The file or folder path
.PARAMETER Recurse
The file or folder path
#>

B. <#
.PARAMETER Path
The file or folder path
.PARAMETER Recurse
Switch to include subfolders
#>

C. <#
.PARAMETER Path
Switch to include subfolders
.PARAMETER Recurse
The file or folder path
#>

D. <#
.PARAMETER Path
The file or folder path
.PARAMETER Recurse
No description needed
#>

Solution

1. Step 1: Match parameter names with correct descriptions

   Path is a string for file/folder path; Recurse is a switch to include subfolders.

2. Step 2: Verify correct PARAMETER sections

   <#
   .PARAMETER Path
   The file or folder path
   .PARAMETER Recurse
   Switch to include subfolders
   #>

   correctly documents Path and Recurse with matching descriptions.

3. Final Answer:

   Correct PARAMETER descriptions for Path and Recurse -> Option B

4. Quick Check:

   Parameter names match descriptions [OK]

Hint: Match parameter names exactly with clear descriptions [OK]

Common Mistakes:

• Swapping descriptions between parameters
• Repeating same description for different params
• Leaving out descriptions for parameters