Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
about_Comment_Based_Help
DESCRIZIONE BREVE
Viene descritta la modalità di scrittura della Guida basata su commenti
relativa a
funzioni e script.
DESCRIZIONE DETTAGLIATA
È possibile scrivere una Guida basata su commenti relativa a
funzioni e script mediante parole chiave commento speciali.
-oppure
<#
.< parola chiave guida>
< contenuto guida>
#>
<#
.Description
Get-Function visualizza il nome e la sintassi di tutte le
funzioni nella sessione.
#>
Ad esempio:
function MyFunction
{
<#
.< parola chiave guida>
< contenuto guida>
#>
<comandi funzione>
}
-oppure
function MyFunction
{
<comandi funzione>
<#
.< parola chiave guida>
< contenuto guida>
#>
}
-oppure
<#
.< parola chiave guida>
< contenuto guida>
#>
function MyFunction { }
Ad esempio:
<#
.< parola chiave guida>
< contenuto guida>
#>
function MyFunction { }
-oppure-
function MyFunction { }
<#
.< parola chiave guida>
< contenuto guida>
#>
.DESCRIPTION
Descrizione dettagliata della funzione o dello script. Questa
parola chiave può essere utilizzata una sola volta in ogni
argomento.
.PARAMETER <Nome-Parametro>
Descrizione di un parametro. È possibile includere una parola
chiave Parameter per ogni parametro nella sintassi della
funzione o dello script.
.EXAMPLE
Comando di esempio che utilizza la funzione o lo script,
seguito facoltativamente da output di esempio e da una
descrizione. Ripetere questa parola chiave per ogni esempio.
.INPUTS
Tipi Microsoft .NET Framework di oggetti che è possibile reindirizzare alla
funzione o allo script. È inoltre possibile includere una
descrizione degli oggetti di input.
.OUTPUTS
Tipo .NET Framework degli oggetti restituiti dal cmdlet. È inoltre
possibile includere una descrizione degli oggetti restituiti.
.NOTES
Informazioni aggiuntive sulla funzione o sullo script.
.LINK
Nome di un argomento correlato. Ripetere questa parola chiave
per ogni argomento correlato.
.ROLE
Ruolo utente per l'argomento della Guida. Contenuto che viene
visualizzato quando il comando Get-Help include il parametro
Role di Get-Help.
.FUNCTIONALITY
Utilizzo previsto della funzione. Contenuto che viene
visualizzato quando il comando Get-Help include il parametro
Functionality di Get-Help.
.FORWARDHELPTARGETNAME <Command-Name>
Reindirizza l'utente all'argomento della Guida relativo al
comando specificato. È possibile reindirizzare gli utenti a
qualsiasi argomento della Guida, inclusi gli argomenti
relativi a una funzione, script, cmdlet o provider.
.FORWARDHELPCATEGORY <Categoria>
Specifica la categoria della Guida dell'elemento in
ForwardHelpTargetName.
I valori validi sono Alias, Cmdlet, HelpFile, Function,
Provider, General, FAQ, Glossary, ScriptCommand,
ExternalScript, Filter o All. Utilizzare questa parola chiave
per evitare conflitti in presenza di comandi con lo stesso nome.
.REMOTEHELPRUNSPACE <variabile-PSSession>
Specifica una sessione che contiene l'argomento della Guida.
Immettere una variabile che contiene PSSession. Questa parola
chiave viene utilizzata dal cmdlet Export-PSSession per
trovare gli argomenti della Guida relativi ai comandi esportati.
Per ulteriori informazioni sul formato del file della Guida basata su XML
del cmdlet, vedere l'argomento relativo alla creazione della Guida dei
cmdlet
in MSDN (Microsoft Developer Network) Library all'indirizzo
http://go.microsoft.com/fwlink/?LinkID=123415 (le informazioni potrebbero
essere in lingua inglese).
Nome:
La sezione nome di un argomento della Guida relativo a
una funzione deriva dal nome della funzione specificato
nella sintassi relativa. Il nome di un argomento della
Guida relativo a uno script deriva dal nome del file di
script. Per modificare il nome o la relativa distinzione
tra maiuscole e minuscole, modificare la sintassi della
funzione o il nome del file di script.
Sintassi:
La sezione sintassi dell'argomento della Guida viene
generata dalla sintassi dello script o della funzione.
Per aggiungere dettagli alla sintassi dell'argomento
della Guida, ad esempio il tipo .NET Framework di un parametro,
aggiungere il dettaglio alla sintassi. Se non si
specifica un tipo di parametro, il tipo "Object" viene
inserito come valore predefinito.
Parametri comuni:
I parametri comuni vengono aggiunti alla sintassi e
all'elenco dei parametri dell'argomento della Guida,
anche se non producono alcun effetto. Per ulteriori informazioni
sui parametri comuni, vedere about_CommonParameters.
Commenti:
La sezione commenti dell'argomento della Guida viene
generata automaticamente dal nome dello script o della
funzione. Non è possibile modificare il contenuto di
questa sezione.
ESEMPI
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
$name = $name + "." + $extension $name
<#
.SYNOPSIS
Aggiunge un'estensione di file a un nome fornito.
.DESCRIPTION
Aggiunge un'estensione di file a un nome fornito. Accetta
qualsiasi stringa per il nome o l'estensione di file.
.PARAMETER Name
Specifica il nome del file.
.PARAMETER Extension
Specifica l'estensione di file. "Txt" è l'estensione predefinita.
.INPUTS
Nessuno. Non è possibile reindirizzare oggetti a
Add-Extension.
.OUTPUTS
System.String. Add-Extension restituisce una stringa con
il nome o l'estensione di file.
.EXAMPLE
C:\PS> extension -name "File"
File.txt
.EXAMPLE
C:\PS> extension -name "File" -extension "doc"
File.doc
.EXAMPLE
C:\PS> extension "File" "doc"
File.doc
.LINK
Versione online: http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
NOME
Add-Extension
SYNOPSIS
Aggiunge un'estensione di file a un nome fornito.
SINTASSI
Add-Extension [[-Name] <String>] [[-Extension] <String>]
[<CommonParameters>]
DESCRIZIONE
Aggiunge un'estensione di file a un nome fornito. Accetta
qualsiasi stringa per il nome o l'estensione di file.
PARAMETRI
-Name
Specifica il nome del file.
Required? false
Position? 0
Valore predefinito
Accept pipeline input? false
Accept wildcard characters?
-Extension
Specifica l'estensione. "Txt" è l'estensione predefinita.
Required? false
Position? 1
Valore predefinito
Accept pipeline input? false
Accept wildcard characters?
<CommonParameters>
Questo cmdlet supporta i parametri comuni -Verbose,
-Debug, ErrorAction, -ErrorVariable, -WarningAction,
-WarningVariable, OutBuffer e -OutVariable. Per
ulteriori informazioni, digitare "get-help
about_commonparameters".
INPUTS
Nessuno. Non è possibile reindirizzare oggetti a
Add-Extension.
OUTPUTS
System.String. Add-Extension restituisce una stringa con
il nome o l'estensione di file.
COLLEGAMENTI CORRELATI
Versione online: http://www.fabrikam.com/extension.html
Set-Item
function Add-Extension
{
param
(
[string]
# Specifica il nome file.
$name,
[string]
# Specifica l'estensione. "Txt" è l'estensione
predefinita.
$extension = "txt"
)
$name = $name + "." + $extension
$name
<#
.SYNOPSIS
Aggiunge un'estensione di file a un nome fornito.
.DESCRIPTION
Aggiunge un'estensione di file a un nome fornito. Accetta
qualsiasi stringa per il nome o l'estensione di file.
.INPUTS
Nessuno. Non è possibile reindirizzare oggetti a
Add-Extension.
.OUTPUTS
System.String. Add-Extension restituisce una stringa con
il nome o l'estensione di file.
.EXAMPLE
C:\PS> extension -name "File"
File.txt
.EXAMPLE
C:\PS> extension -name "File" -extension "doc"
File.doc
.EXAMPLE
C:\PS> extension "File" "doc"
File.doc
.LINK
Versione online: http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
<#
.SYNOPSIS
Esegue aggiornamenti mensili dei dati.
.DESCRIPTION
Lo script Update-Month.ps1 aggiorna il Registro di sistema
con i nuovi dati generati lo scorso mese e genera un report.
.PARAMETER InputPath
Specifica il percorso del file di input basato su CSV.
.PARAMETER OutputPath
Specifica il nome e il percorso del file di output basato
su CSV. Per impostazione predefinita, MonthlyUpdates.ps1
genera un nome in base alla data e all'ora in cui viene
eseguito e salva l'output nella directory locale.
.INPUTS
Nessuno. Non è possibile reindirizzare oggetti a
Update-Month.ps1.
.OUTPUTS
Nessuno. Update-Month.ps1 non genera alcun output.
.EXAMPLE
C:\PS> .\Update-Month.ps1
.EXAMPLE
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
.EXAMPLE
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
-outputPath C:\Reports\2009\January.csv
#>
function Get-Data { }
...
NOME
C:\ps-test\Update-Month.ps1
SYNOPSIS
Esegue aggiornamenti mensili dei dati.
SINTASSI
C:\ps-test\Update-Month.ps1 [-InputPath] <String>
[[-OutputPath] ]<String>] [<CommonParameters>]
DESCRIZIONE
Lo script Update-Month.ps1 aggiorna il Registro di
sistema con i nuovi dati generati lo scorso mese e
genera un report.
PARAMETRI
-InputPath
Specifica il percorso del file di input basato su CSV.
Required? true
Position? 0
Valore predefinito
Accept pipeline input? false
Accept wildcard characters?
-OutputPath
Specifica il nome e il percorso del file di output
basato su CSV. Per impostazione predefinita,
MonthlyUpdates.ps1 genera un nome in base alla
data e all'ora in cui viene eseguito e salva
l'output nella directory locale.
Required? false
Position? 1
Valore predefinito
Accept pipeline input? false
Accept wildcard characters?
<CommonParameters>
Questo cmdlet supporta i parametri comuni
-Verbose, -Debug, ErrorAction, -ErrorVariable,
-WarningAction, -WarningVariable, OutBuffer e
-OutVariable. Per ulteriori informazioni,
digitare "get-help about_commonparameters".
INPUT
Nessuno. Non è possibile reindirizzare oggetti a
Update-Month.ps1.
OUTPUT
Nessuno. Update-Month.ps1 non genera alcun output.
COLLEGAMENTI CORRELATI
# .ExternalHelp C:\MyScripts\Update-Month-Help.xml
function Get-Data { }
...
function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension $name
# .ExternalHelp C:\ps-test\Add-Extension.xml }
function help
{
<#
.FORWARDHELPTARGETNAME Get-Help
.FORWARDHELPCATEGORY Cmdlet
#>
[CmdletBinding(DefaultParameterSetName='AllUsersView')] param(
[Parameter(Position=0, ValueFromPipelineByPropertyName
=$true)] [System.String]
${Name},
...
NOME
Get-Help
SYNOPSIS
Visualizza informazioni sui cmdlet e i concetti
relativi a Windows PowerShell.
...
VEDERE ANCHE
about_Functions
about_Functions_Advanced_Parameters
about_Scripts
"Modalità di scrittura della Guida dei cmdlet"
(http://go.microsoft.com/fwlink/?LinkID=123415)
(le informazioni potrebbero essere in lingua inglese)