PowerShell 评论 |快速浏览 PowerShell 评论

PowerShell评论简介

PowerShell 注释是一种提供代码基本简短细节的帮助。您可以向 PowerShell 脚本的任何部分添加注释，例如可以为函数提供的注释或可以为条件、循环等提供的注释。正在阅读代码的脚本编写者将很容易理解代码的含义。我们还可以使用评论来提供帮助部分。脚本执行时不会显示注释；它仅用于用户信息。

PowerShell 注释的类型

我们可以使用两种类型的 PowerShell 注释：

• 单行注释：这也称为内联注释，它只能注释掉一行。
• 多行注释：这也称为块注释，适用于几行代码或整个代码。

语法：

单行注释或行内注释可以用Hash(#)语法来描述，多行注释或块注释可以用标签和Hash来描述，如

示例

下面给出了 PowerShell 注释的示例：

例子#1

单行注释来描述代码。

代码：

Rename-Item C:\Temp\azgroup.json -NewName azuregroup.json  # This command will rename the item

例子#2

单个注释来描述该功能。

代码：

function GetData{
#Function will get the data from azure blob
}

例子#3

注释以禁用特定代码。

代码：

# Copy-Item C:\Temp\NewUsers.csv -Destination \test1-win2k12\c$\temp

当您对任何代码进行注释时，您可能会注意到线条的颜色发生变化。这取决于编辑器以及您为该编辑器应用的主题。如果您有一起描述多行的块，例如“循环”、“函数”、“for循环”等，并且如果您对单行应用注释，则可能会生成错误。

代码：

while($i -gt 10){
Write-Output $i
$i++
}

如果在上面的示例中使用注释禁用第一行，则会生成错误。

代码：

# while($i -gt 10){
Write-Output $i
$i++
}

输出：

该错误表明不需要额外的“}”，因为我们已经禁用了“{”。您可以使用单行注释来禁用多行代码。

代码：

# while($i -gt 10){
#  Write-Output $i
#  $i++
#}

但不推荐这种方法；相反，我们可以使用多行注释来禁用它们，这将在后续示例中显示。

例子#4

多行注释来描述脚本。

代码：

<#
This program is to test the server connectivity.
Once connectivity establishes it checks the WINRM connection on the server.
The third step is to push the Application agent on the servers
In the final step, server will be rebooted
#>

在上面的例子中，我们使用PowerShell创建了一个多行注释块，并且它不会被执行。当您想要放置有关参数的具体详细信息（例如日期格式）或用户在执行脚本之前应注意（例如日志的输出路径）时，可以使用它。

例子#5

多行注释可禁用该功能或部分代码。

如示例“c”所示，我们可以使用单行注释禁用整个 while 循环，但使用多行注释会更容易。

代码：

<#while($i -gt 10){
Write-Output $i
$i++
}#>

它比单行注释容易得多。

基于 PowerShell 注释的帮助

这也是一种多行注释。基于 PowerShell 注释的关键字帮助工作。每个关键字都描述了其预期用途的特定主题，并且可以在多行注释部分中使用它们。

这些关键字可以以任意顺序出现，并且不区分大小写，并且以点（.）开头。没有必要提及所有关键字。您可以根据您的要求添加其中一些。

• .概要：函数或脚本的简短描述。 该关键字仅使用一次。
• .描述：脚本的详细描述。 该关键字仅使用一次。
• .EXAMPLE：脚本示例以及输入和输出。我们可以添加多个示例。
• .PARAMETER ： 参数的描述。该关键字可用于脚本中的每个参数。它可以采用任何顺序，但在 Param() 块中提到它们的顺序将出现在帮助部分中。
• .INPUTS： 输入对象或可通过管道传输到脚本或函数的对象类型的描述。
• .OUTPUTS： 返回的对象或 cmdlet 返回的对象类型的描述。

以上是我们描述功能的基于注释的帮助部分一般需要的基本关键字。除此之外，您还可以指定其他关键字，例如NOTES、LINK、COMPONENT、ROLE、FUNCTIONALITY等。

示例：

代码：

function TestRemotePort{
param(
[String]$ComputerName,
[Int]$Port
)
<#
.SYNOPSIS
Function to test remote ports.
.DESCRIPTION
This script checks port on the remote computers
.EXAMPLE
TestRemotePort -ComputerName ServerName -Port 8080
.PARAMETER ComputerName
Remote Server Name
.PARAMETER Port
Remote port number
.INPUTS
ComputerNames can be passed and a port can be passed
.OUTPUTS
True or False
#>
Test-NetConnection -ComputerName $ComputerName -Port $Port
}

输出：

您还可以将基于注释的帮助放在脚本的开头。

代码：

<#
.DESCRIPTION
This script will test the connection with the remote server
#>
param(
[Parameter(Mandatory=$true)]
[String]$Server
)
Test-Connection -ComputerName $Server -Count 2 -quiet

输出：

基于注释的帮助可以放在脚本的末尾。

代码：

function TestNetConnection{
Test-Netconnection -ComputerName $computername -Port $port
}
<#
.DESCRIPTION
The above function checks the port on the remote computer.
#>