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

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

Ответы

Ответ 1

В 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 ([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 или внутри {} до или после самого кода.

Ответ 2

Вы используете хеш-метку, подобную этой

# This is a comment in Powershell

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

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

Ответ 4

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

# Comment Here

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

<# 
  Multi 
  Line 
#>

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

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

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

Ответ 5

Здесь

# Single line comment in Powershell

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

Ответ 6

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

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

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

Ответ 7

В PowerShell ISE вы можете нажать Strg + J, чтобы открыть меню "Начать свертывание" и выбрать блок комментариев:

введите описание изображения здесь