Как вы закомментируете код в PowerShell? - PullRequest
891 голосов
/ 08 сентября 2011

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

Ответы [ 7 ]

1187 голосов
/ 08 сентября 2011

В 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 CmdLet и могут быть помещены перед ключевым словом Function или внутри {} до или после самого кода.

95 голосов
/ 08 сентября 2011

Вы используете такую ​​хэш-метку, как эта

# This is a comment in Powershell

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

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

38 голосов
/ 08 сентября 2011

Это #.

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

30 голосов
/ 17 сентября 2015

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

# Comment Here

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

<# 
  Multi 
  Line 
#> 

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

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

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

15 голосов
/ 17 сентября 2015

Здесь

# Single line comment in Powershell

<# 
--------------------------------------
Multi-line comment in PowerShell V2+ 
-------------------------------------- 
#>
13 голосов
/ 21 апреля 2017

В PowerShell ISE вы можете нажать Ctrl + J , чтобы открыть меню Start Snipping и выбрать Блок комментариев :

enter image description here

3 голосов
/ 25 июля 2016

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

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

 <#
    for more lines
    ...
    ...
    ...
    ..
    .
 #>
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...