关于语法：如何在PowerShell中注释掉代码？


How do you comment out code in PowerShell?

你如何在PowerShell(1.0或2.0)中注释掉代码？

相关讨论

在PowerShell V1中，只有#才能在注释后生成文本。

1
# This is a comment in Powershell

在PowerShell V2中，<# #>可用于块注释，更具体地用于帮助注释。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#REQUIRES -Version 2.0

<#
.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 ([email protected])
    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
#>
Function blabla
{}

有关.SYNOPSIS和.*的更多说明，请参阅about_Comment_Based_Help。

备注：这些函数注释由Get-Help CmdLet使用，可以放在关键字Function之前，也可以放在代码本身之前或之后的{}之内。

相关讨论

你使用这样的哈希标记

1
# This is a comment in Powershell

维基百科有一个很好的页面，可以跟踪如何用几种流行语言进行评论

http://en.wikipedia.org/wiki/Comparison_of_programming_languages_(syntax)#Comments

这是#。

有关特殊字符，请参阅PowerShell - 特殊字符和标记。

单行注释以井号开头，#右侧的所有内容都将被忽略：

1
# Comment Here

在PowerShell 2.0及更高版本中，可以使用多行块注释：

1
2
3
4
<#
  Multi
  Line
#>

您可以使用块注释在命令中嵌入注释文本：

1
Get-Content -Path <# configuration file #> C:\config.ini

注意：由于PowerShell支持Tab Completion，因此在注释之前需要注意复制和粘贴Space + TAB。

相关讨论

这里

1
2
3
4
5
6
7
# Single line comment in Powershell

<#
--------------------------------------
Multi-line comment in PowerShell V2+
--------------------------------------
#>
相关讨论

在PowerShell ISE中，您可以点击Ctrl + J打开Start Snipping菜单并选择Comment block：

enter image description here

相关讨论

你(们)能做到：

1
2
3
4
5
6
7
8
9
10
 (Some basic code) # Use"#" after a line and use:

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>