PowerTip: Use PowerShell Multiple-Line Comments

PowerTip: Use PowerShell Multiple-Line Comments

  • Comments 3
  • Likes

Summary: Use Windows PowerShell multiple-line comments in your script or from the console.

Hey, Scripting Guy! Question How do you type a multiple-line comment?

Hey, Scripting Guy! Answer Begin the comment with the <# tag, and end the comment with the #> tag:

<#

 this is a comment

            on several

            different

            lines

 #>

Your comment has been posted.   Close
Thank you, your comment requires moderation so it may take a while to appear.   Close
Leave a Comment
  • <#

    this works good, but less convenient then the

    comment/uncomment buttons in my IDE

    #>

  • @Knuckle-Dragger of course. But it is nice to have options :-)

  • Use multi-line comments to insert quick help into modules, functions and scripts.  Teh follwoing can be autoinserted when a new fie is creted or it can be inserted via the menu in your fovorite ISE or IDE

    <#

    #requires -version 2.0

    .SYNOPSIS

    .DESCRIPTION

    .PARAMETER  <Parameter-Name>

    .EXAMPLE

    .INPUTS

    .OUTPUTS

    .NOTES

       Author: <author>

       Created: <mm-dd-yyyy>

    .LINK

    #>