Як ви коментуєте код у PowerShell?

Як ви коментуєте код у PowerShell (1.0 чи 2.0)?

У 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та .*перегляду про_Коментар_Бес_Допомога .

Зауваження: ці коментарі до функцій використовуються Get-HelpCmdLet і можуть бути поставлені перед ключовим словом Function, або всередині {}до або після самого коду.

Ви використовуєте такий хеш-знак

# This is a comment in Powershell

У Вікіпедії є хороша сторінка для відстеження того, як робити коментарі кількома популярними мовами

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

Це #.

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

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

# Comment Here

У багаторядкових блокових коментарях PowerShell 2.0 і вище можна використовувати:

<# 
  Multi 
  Line 
#> 

Ви можете використовувати блокові коментарі, щоб вставити текст коментаря в команду:

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

Примітка: Оскільки PowerShell підтримує завершення вкладки, вам потрібно бути обережним щодо копіювання та вставлення Space + TABперед коментарями.

Ось

# Single line comment in Powershell

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

У PowerShell ISE ви можете натиснути Ctrl+, Jщоб відкрити меню « Пуск прорізування » та вибрати блок «Коментар» :

Ви можете зробити:

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

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