How do you comment out code in PowerShell

Question

How do you comment out code in PowerShell  1 0 or 2 0

User · Answer

Within PowerShell ISE you can hit Ctrl J to open the Start Snipping  menu and select Comment block

User · Answer

There is a special way of inserting comments add the end of script       exit   Hi Hello We are comments And not executed   Anything after exit is not executed  and behave quite like comments

User · Answer

Here    Single line comment in Powershell   lt    -------------------------------------- Multi-line comment in PowerShell V2   --------------------------------------    gt

User · Answer

Use a hashtag followed by a white-space    for this     comment here  Do not forget the whitespace here  Otherwise it can interfere with internal commands  E g  this is NOT a comment   requires -runasadmin

User · Answer

You can make     Some basic code    Use     after a line and use     lt       for more lines                                         gt

User · Answer

It s the     See PowerShell - Special Characters And Tokens for special characters

User · Answer

You use the hash mark like this    This is a comment in Powershell   Wikipedia has a good page for keeping track of how to do comments in several popular languages  http   en wikipedia org wiki Comparison of programming languages  syntax  Comments

User · Answer

In PowerShell V1 there s only   to make the text after it a comment     This is a comment in Powershell   In PowerShell V2  lt     gt  can be used for block comments and more specifically for help comments    REQUIRES -Version 2 0   lt    SYNOPSIS     A brief description of the function or script  This keyword can be used     only once in each topic   DESCRIPTION     A detailed description of the function or script  This keyword can be     used only once in each topic   NOTES     File Name        xxxx ps1     Author           J P  Blanc  jean-paul blanc silogix-fr com      Prerequisite     PowerShell V2 over Vista and upper      Copyright 2011 - Jean Paul Blanc Silogix  LINK     Script posted over      http   silogix fr  EXAMPLE     Example 1  EXAMPLE     Example 2   gt  Function blabla      For more explanation about  SYNOPSIS and    see about Comment Based Help   Remark  These function comments are used by the Get-Help CmdLet and can be put before the keyword Function  or inside the    before or after the code itself

User · Answer

I m a little bit late to this party but seems that nobody actually wrote all use cases  So    Only supported version of PowerShell these days  fall of 2020 and beyond  are   Windows PowerShell 5 1 x PowerShell 7 0 x   You don t want to or you shouldn t work with different versions of PowerShell  Both versions  or any another version which you could come around WPS 3 0-5 0  PS Core 6 x x on some outdated stations  share the same comment functionality  One line comments   Get all Windows Service processes  lt -- one line comment  it starts with     Get-Process -Name  host   Get-Process -Name  host     You could put as many     as you want  it does not matter  Get-Process -Name  host      Stop-Service   Everything from the first   until end of the line is treated as comment  Stop-Service -DisplayName Windows Update   -WhatIf   You can use it to comment out cmdlet switches  Multi line comments  lt   Everyting between   lt     and     gt   is  treated as a comment  A typical use case is for help  see below     You could also have a single line comment inside the multi line comment block    Or two          gt    lt    SYNOPSIS     A brief description of the function or script      This keyword can be used only once in each topic    DESCRIPTION     A detailed description of the function or script      This keyword can be used only once in each topic    NOTES     Some additional notes  This keyword can be used only once in each topic      This keyword can be used only once in each topic    LINK     A link used when Get-Help with a switch -OnLine is used      This keyword can be used only once in each topic    EXAMPLE     Example 1     You can use this keyword as many as you want    EXAMPLE     Example 2     You can use this keyword as many as you want    gt   Nested multi line comments  lt   Nope  these are not allowed in PowerShell    lt   This will break your first multiline comment block      gt     and this will throw a syntax error    gt   In code nested multi line comments  lt    The multi line comment opening close can be also used to comment some nested code or as an explanation for multi chained operations     gt  Get-Service    lt   Step explanation   gt  Where-Object      Status -eq  ServiceProcess ServiceControllerStatus   Stopped       lt   Format-Table -Property DisplayName  Status -AutoSize    gt  Out-File -FilePath Services txt -Encoding Unicode  Edge case scenario   Some well written script exit Writing something after exit is possible but not recommended  It isn t a comment  Especially in Visual Studio Code  these words baffle PSScriptAnalyzer  You could actively break your session in VS Code

User · Answer

Single line comments start with a hash symbol  everything to the right of the   will be ignored     Comment Here   In PowerShell 2 0 and above multi-line block comments can be used    lt      Multi    Line    gt     You could use block comments to embed comment text within a command   Get-Content -Path  lt   configuration file   gt  C  config ini   Note  Because PowerShell supports Tab Completion you need to be careful about copying and pasting Space   TAB before comments

[powershell] How do you comment out code in PowerShell?

Examples related to powershell

Examples related to syntax

Examples related to powershell-2.0

Examples related to comments