PowerShell注释

本文概述

• 单行注释
• 多行注释

当你想通过提供有关代码的信息来帮助他人时, 则必须使用该代码中的注释。

与其他编程或脚本语言一样, 你可以在PowerShell中提供注释以用于文档目的。

在PowerShell中, 有两种类型的注释：

• 单行注释
• 多行注释或注释块

单行注释

单行注释是你可以在每行的开头键入井号＃的注释。井号右侧的所有内容都将被忽略。如果在脚本中编写多行, 则必须在每行的开头使用井号＃符号。

单行注释的语法

以下是单行注释的两种语法：

语法1：

<Any Command or statement> # <Any comment>

语法2：

# <Any comment> 
<Any Command or statement>

例子

示例1：此示例显示如何在行尾使用注释

PS C:\> get-childitem #this command displays the child items of the C: drive

示例2：此示例显示如何在代码之前和任何语句末尾使用注释。

PS C:\> #This code is used to print the even numbers from 1 to 10
PS C:\> for($i = 1; $i -le 10; $i++) # This loop statement initialize variable from 1
and increment upto 10.
>> {
>> $x=$i%2
>> if($x -eq 0) # The if condition checks that the value of variable x is equalt to 
0, if yes then execute if body
>> {
>> echo $i # This statement prints the number which is divisibel by 2
>> }
>> }

输出

2
4
6
8
10

多行注释

在PowerShell 2.0或更高版本中, 引入了多行注释或块注释。要注释多行, 请将<＃符号放在第一行的开头, 将＃>符号放在最后一行的末尾。

多行注释的语法

以下块显示多行注释的语法：

<# Multiple line Comment.........
.........
....................#>
Statement-1
Statement-2
Statement-N

示例：下面的示例描述如何在代码中使用多行注释。

PS C:\> <# This code is used to print the
>> factorial of a given number#>
PS C:\> $a=5
PS C:\> $fact=1
PS C:\> for ($i=$a;$i -ge 1;$i--)
>> {
>> $fact=$fact * $i;
>> }

键入以下命令以显示以上示例的输出：

PS C:\> $fact
120