Como você comenta o código em PowerShell?
7 answers
Em PowerShell V1 só existe # para fazer do texto a seguir um comentário.
# This is a comment in Powershell
In PowerShell V2 <# #> can be used for block comments and more specifically for help comments.
#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
{}
Para mais explicações sobre .SYNOPSIS e .* Ver about_ comment_ based_help .
Observação: estes comentários de função são usados pelo Get-Help CmdLet e podem ser colocados antes da palavra-chave Function, ou dentro do {} antes ou depois do próprio código.
Usa a marca de hash assim
# This is a comment in Powershell
A Wikipédia tem uma boa página para acompanhar como fazer comentários em várias línguas populares
Http://en.wikipedia.org/wiki/Comparison_of_programming_languages_(syntax)#Comments
Ver PowerShell-caracteres especiais e fichas para personagens especiais.
Os comentários de linha única começam com um símbolo de hash , tudo à direita do # será ignorado:
# Comment Here
Em PowerShell 2.0 e acima de blocos multi-linhas podem ser utilizados comentários:
<#
Multi
Line
#>
Pode usar os comentários em bloco para incorporar o texto do comentário num comando:
Get-Content -Path <# configuration file #> C:\config.ini
Nota: Porque o PowerShell suporta completação de páginas , tem de ter cuidado com a cópia e colagem {[[4]} antes dos comentários.
Aqui
# Single line comment in Powershell
<#
--------------------------------------
Multi-line comment in PowerShell V2+
--------------------------------------
#>
Em PowerShell ISE podes carregar em Ctrl+J para abrir o Comece a cortar o menü e seleccione o bloco de comentários:
Podes fazer:
(Some basic code) # Use "#" after a line and use:
<#
for more lines
...
...
...
..
.
#>