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