PoshTip #10 – How to comment lines in PowerShell ?

PoshTip #10 – How to comment lines in PowerShell ?

You should document your scripts with comments because these make the code easier to read.

Single-line comments

You just have to append the text with the # character. Below is an example :

Function BackupDB {

# Folder where I want my backup to end up
$BKPFolder = "C:\TMP"

}

# Now call the function
BackupDB

Comment blocks

For multiple lines, you don’t have to add a # to each line :

<# This is a comment
   line number 1
   line number 2
   line ...
#>

Function BackupDB() {

# Folder where I want my backup to end up
$BKPFolder = "C:\TMP"

}

# Now call the function
BackupDB

Except version 1, PowerShell supports comment blocks.