Как вы комментируете код в PowerShell?

Как вы комментируете код в PowerShell (1.0 или 2.0)?

835
commenting powershell powershell-v2.0 syntax

7 ответов

в PowerShell V1 есть только # чтобы сделать текст после него комментарием.

# This is a comment in Powershell

В PowerShell V2 <# #> можно использовать для комментариев блока и более конкретно для комментариев справки.

#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 (jean-paul_blanc@silogix-fr.com)
    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 командлет и может быть поставлен перед ключевым словом Function или внутри {} до или после самого кода.

1113

вы используете хэш-метку вот так

# This is a comment in Powershell

Википедия имеет хорошую страницу для отслеживания комментариев на нескольких популярных языках

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

94

Это #.

посмотреть PowerShell-Специальные Символы И Маркеры для специальных символов.

38

однострочные комментарии начинаются с хэш-символ, все справа от # будет проигнорирован:

# Comment Here

в PowerShell 2.0 и выше можно использовать многострочные комментарии блоков:

<# 
  Multi 
  Line 
#>

вы можете использовать блок комментариев для вставки текста комментария в команду:

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

Примечание: потому что PowerShell поддерживает Завершение вы должны быть осторожны с копированием и вставкой Space + TAB перед комментарии.

26

здесь

# Single line comment in Powershell

<# 
--------------------------------------
Multi-line comment in PowerShell V2+ 
-------------------------------------- 
#>
15

в PowerShell ISE вы можете нажать Ctrl+J открыть Начать Отсекать menü и выберите комментарий блок:

enter image description here

8

вы можете сделать:

 (Some basic code) # Use "#" after a line and use:

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