如何在 PowerShell 中注释掉代码

要注释掉单行 PowerShell 脚本，请在该行的开头使用 #。在 PowerShell 中注释掉代码以像其他编程语言一样创建文档。

在 PowerShell 中，您可以注释掉单行，也可以创建注释块来注释掉 PowerShell 脚本中的多行。

在本示例中，我们将讨论如何在 PowerShell 脚本中进行注释以及如何在 PowerShell 中阻止注释。

PowerShell 脚本中的单行注释

使用#（井号）符号注释掉 PowerShell 脚本中的单行。行开头的 # 将注释掉脚本中的整行。

# Gets the members for the Get-ChildItem cmdlet in PowerShell
Get-ChildItem | Get-Member

在上面的 PowerShell 脚本中，注释掉第一行。它使用#开头。

它将仅执行 Get-ChildItem| Get-Member 命令获取可用于 Get-ChildItem cmdlet 的所有成员。

PowerShell 评论块

使用 符号创建注释块。注释块中的所有行都被解释为注释。

PowerShell 中的注释块可以包含单行，也可以跨多行。

使用结束评论。

<# Get-Content - It gets the content of the item at the location
   specifed by the path, such as text in a file or content of function.
   For files, the content is read one line at a time
 #>

Get-Content -Path D:\PS\calc.txt 

在上面的 PowerShell 脚本中，我们使用 符号注释掉了多行。

上面的脚本仅运行 Get-Content cmdlet 来读取文件的内容。

PowerShell 中基于注释的帮助

在 PowerShell 中，您可以使用 注释掉基于注释的帮助部分。

在基于注释的帮助中，每个部分均由关键字和关键字开头的点 (.) 定义。

<# 
    .Synopis
        Get the square root of the number
    
    .Description
        The Get-SquareRoot cmdlet gets the number and calculate the square root

    .Parameter
        -Number <int>

    .Example
        Get-SquareRoot -Number 4

    .Syntax
        Get-SquareRoot -Number
 #>

 

在上面的 PowerShell 脚本中，注释块包含帮助关键字，如概要、描述、参数等……

结论

我希望上述关于在 PowerShell 中使用 #（井号）符号进行单行注释的文章对您有所帮助。

您可以在 PowerShell 脚本或 PowerShell 中基于注释的帮助中注释掉多行。

您可以在 ShellGeek 主页上找到有关 PowerShell Active Directory 命令和 PowerShell 基础知识的更多主题