Yoruma Dayalı Yardım hakkında

Kısa açıklama

İşlevler ve komut dosyaları için yoruma dayalı yardım konularının nasıl yazılacağını açıklar.

Uzun açıklama

Özel yardım yorumu anahtar sözcüklerini kullanarak işlevler ve komut dosyaları için yoruma dayalı yardım konuları yazabilirsiniz.

Get-Help cmdlet'i, yoruma dayalı yardımı, XML dosyalarından oluşturulan cmdlet yardım konularını görüntülediği biçimde görüntüler. Kullanıcılar Ayrıntılı, Tam, Örnekler ve < gibi Yardım Edin parametrelerinin tümünü kullanabilir.Çevrimiçi, yoruma dayalı yardımın içeriğini görüntülemek için.

Ayrıca işlevler ve komut dosyaları için XML tabanlı yardım dosyaları da yazabilirsiniz. Bir işlev veya komut dosyası için XML tabanlı yardım dosyasını bulmak üzere Get-Help cmdlet'ini etkinleştirmek için .ExternalHelp anahtar sözcüğünü kullanın. Bu anahtar kelime olmadan Get-Help, işlevler veya komut dosyaları için XML tabanlı yardım konularını bulamaz.

Bu konu, işlevler ve komut dosyaları için yardım konularının nasıl yazılacağını açıklamaktadır. İşlevler ve komut dosyaları için yardım konularının nasıl görüntüleneceği hakkında bilgi için bkz. Get-Help.

Güncelleştirme-Yardım ve Kaydet-Yardım cmdlet'leri yalnızca XML dosyalarında çalışır. Güncellenebilir Yardım, yoruma dayalı yardım konularını desteklemez.

Yoruma dayalı yardım için sözdizimi

Yoruma dayalı yardımın sözdizimi aşağıdaki gibidir:

# .<help keyword>
# <help content>

veya

<#
.<help keyword>
<help content>
#>

Yoruma dayalı yardım bir dizi yorum olarak yazılır. Her yorum satırından önce bir yorum simgesi # yazabilirsiniz veya bir yorum bloğu oluşturmak için <# ve #> simgelerini kullanabilirsiniz . Yorum bloğundaki tüm satırlar yorum olarak yorumlanır.

Yoruma dayalı bir yardım konusundaki tüm satırlar bitişik olmalıdır. Yoruma dayalı bir yardım konusu, yardım konusunun parçası olmayan bir yorumun ardından geliyorsa, yardımla ilgili olmayan son yorum satırı ile yoruma dayalı yardımın başlangıcı arasında en az bir boş satır olmalıdır.

Anahtar sözcükler, yoruma dayalı yardımın her bölümünü tanımlar. Her yoruma dayalı yardım anahtar sözcüğünün önünde bir nokta . bulunur. Anahtar kelimeler herhangi bir sırada görünebilir. Anahtar kelime adları büyük/küçük harfe duyarlı değildir.

Örneğin, .Description anahtar sözcüğü, bir işlevin veya komut dosyasının açıklamasından önce gelir.

<#
.Description
Get-Function displays the name and syntax of all functions in the session.
#>

Yorum bloğu en az bir anahtar kelime içermelidir. .EXAMPLE gibi bazı anahtar kelimeler aynı yorum bloğunda birçok kez görünebilir. Her anahtar kelimenin yardım içeriği, anahtar kelimeden sonraki satırda başlar ve birden fazla satıra yayılabilir.

İşlevlerde yoruma dayalı yardım için sözdizimi

Bir işleve ilişkin yoruma dayalı yardım üç konumdan birinde görüntülenebilir:

İşlev gövdesinin başlangıcında.
İşlev gövdesinin sonunda.
işlev anahtar sözcüğünden önce. İşlev yardımının son satırı ile işlev anahtar sözcüğü arasında birden fazla boş satır olamaz.

Örneğin:

function Get-Function
{
<#
.<help keyword>
<help content>
#>

  # function logic
}

veya

function Get-Function
{
   # function logic

<#
.<help keyword>
<help content>
#>
}

veya

<#
.<help keyword>
<help content>
#>
function Get-Function { }

Komut dosyalarında yoruma dayalı yardım için sözdizimi

Bir komut dosyasına ilişkin yoruma dayalı yardım, komut dosyasında aşağıdaki iki konumdan birinde görünebilir.

Komut dosyasının başında. Komut dosyası yardımından önce komut dosyasında yalnızca yorumlar ve boş satırlar bulunabilir.
Betik gövdesindeki ilk öğe (yardımdan sonra) bir işlev bildirimi ise, betik yardımının sonu ile işlev bildirimi arasında en az iki boş satır bulunmalıdır. Aksi takdirde yardım, komut dosyası için değil, işlev için yardım olarak yorumlanır.
Komut dosyasının sonunda. Ancak komut dosyası imzalanmışsa, Yorum tabanlı yardımı komut dosyası dosyasının başına yerleştirin. Komut dosyasının sonu imza bloğu tarafından işgal edilir.

Örneğin:

<#
.<help keyword>
<help content>
#>


function Get-Function { }

veya

function Get-Function { }

<#
.<help keyword>
<help content>
#>

Komut dosyası modüllerinde yoruma dayalı yardım için sözdizimi

.psm1 komut dosyası modülünde, yoruma dayalı yardım, komut dosyalarının sözdizimini değil, işlevler için sözdizimini kullanır. Bir komut dosyası modülünde tanımlanan tüm işlevler için yardım sağlamak amacıyla komut dosyası sözdizimini kullanamazsınız.

Örneğin, bir komut dosyası modülündeki işlevlere ilişkin XML tabanlı yardım dosyalarını tanımlamak için .ExternalHelp anahtar sözcüğünü kullanıyorsanız, her birine bir .ExternalHelp açıklaması eklemeniz gerekir. işlev.

# .ExternalHelp <XML-file-name>
function <function-name>
{
  ...
}

Yoruma dayalı yardım anahtar kelimeleri

Aşağıdakiler geçerli yoruma dayalı yardım anahtar sözcükleridir. Kullanım amaçlarıyla birlikte genellikle bir yardım konusunda göründükleri sıraya göre listelenirler. Bu anahtar sözcükler, yoruma dayalı yardımda herhangi bir sırada görünebilir ve büyük/küçük harfe duyarlı değildir.

.ÖZET

İşlev veya komut dosyasının kısa bir açıklaması. Bu anahtar kelime her konu içerisinde yalnızca bir kez kullanılabilir.

.TANIM

İşlev veya komut dosyasının ayrıntılı açıklaması. Bu anahtar kelime her konuda yalnızca bir kez kullanılabilir.

.PARAMETRE

Bir parametrenin açıklaması. İşlev veya komut dosyası sözdizimindeki her parametre için bir .PARAMETER anahtar sözcüğü ekleyin.

Parametre adını .PARAMETER anahtar sözcüğüyle aynı satıra yazın. .PARAMETER anahtar sözcüğünden sonraki satırlara parametre açıklamasını yazın. Windows PowerShell, .PARAMETER satırı ile sonraki anahtar kelime veya yorum bloğunun sonu arasındaki tüm metni parametre açıklamasının parçası olarak yorumlar. Açıklama paragraf sonlarını içerebilir.

.PARAMETER  <Parameter-Name>

Parametre anahtar sözcükleri yorum bloğunda herhangi bir sırada görünebilir, ancak işlev veya komut dizisi sözdizimi, parametrelerin (ve açıklamalarının) yardım konusunda görüneceği sırayı belirler. Sırayı değiştirmek için sözdizimini değiştirin.

Ayrıca, parametre değişkeni adından hemen önce işlev veya kod sözdizimine bir yorum yerleştirerek de bir parametre açıklaması belirtebilirsiniz. Bunun işe yaraması için en az bir anahtar kelime içeren bir yorum bloğunuz da olmalıdır.

Hem sözdizimi yorumu hem de .PARAMETER anahtar sözcüğünü kullanırsanız, .PARAMETER anahtar sözcüğüyle ilişkilendirilen açıklama kullanılır ve sözdizimi yorumu yoksayılır.

<#
.SYNOPSIS
    Short description here
#>
function Verb-Noun {
    [CmdletBinding()]
    param (
        # This is the same as .Parameter
        [string]$Computername
    )
    # Verb the Noun on the computer
}

.ÖRNEK

İsteğe bağlı olarak örnek çıktı ve açıklamanın takip ettiği, işlevi veya betiği kullanan örnek bir komut. Bu anahtar kelimeyi her örnek için tekrarlayın.

.GİRİŞLER

İşleve veya betiğe aktarılabilecek .NET nesne türleri. Giriş nesnelerinin bir açıklamasını da ekleyebilirsiniz.

.ÇIKIŞLAR

Cmdlet'in döndürdüğü nesnelerin .NET türü. Ayrıca döndürülen nesnelerin bir açıklamasını da ekleyebilirsiniz.

.NOTLAR

İşlev veya komut dosyası hakkında ek bilgi.

.BAĞLANTI

İlgili bir konunun adı. Değer, ".LINK" anahtar sözcüğünün altındaki satırda görünür ve önüne bir yorum simgesi # gelmeli veya yorum bloğuna dahil edilmelidir.

İlgili her konu için .LINK anahtar kelimesini tekrarlayın.

Bu içerik yardım konusunun İlgili Bağlantılar bölümünde görünür.

.Link anahtar kelime içeriği aynı yardım konusunun çevrimiçi sürümüne yönelik bir Tekdüzen Kaynak Tanımlayıcısı (URI) da içerebilir. Get-Help'in Çevrimiçi parametresini kullandığınızda çevrimiçi sürüm açılır. URI "http" veya "https" ile başlamalıdır.

.BİLEŞEN

İşlev veya betiğin kullandığı ya da ilişkili olduğu teknolojinin veya özelliğin adı. Get-Help'in Bileşen parametresi, Get-Help tarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.ROL

Yardım konusu için kullanıcı rolünün adı. Get-Help'in Role parametresi, Get-Help tarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.İŞLEVSELLİK

İşlevin kullanım amacını açıklayan anahtar kelimeler. Get-Help'in İşlevsellik parametresi, Get-Help tarafından döndürülen arama sonuçlarını filtrelemek için bu değeri kullanır.

.FORWARDHELPTARGETNAME

Belirtilen komutun yardım konusuna yönlendirir. Kullanıcıları bir işlev, komut dosyası, cmdlet veya sağlayıcıya ilişkin yardım konuları da dahil olmak üzere herhangi bir yardım konusuna yönlendirebilirsiniz.

# .FORWARDHELPTARGETNAME <Command-Name>

.İLERİYARDIMKATEGORİSİ

.ForwardHelpTargetName içindeki öğenin yardım kategorisini belirtir. Geçerli değerler şunlardır: Alias, Cmdlet, HelpFile, Function, Provider, Genel, SSS, Sözlük, ScriptCommand, ExternalScript, Filtre veya Tümü. Aynı ada sahip komutlar olduğunda çakışmaları önlemek için bu anahtar sözcüğü kullanın.

# .FORWARDHELPCATEGORY <Category>

.UZAKTAN YARDIMPRUNSPACE

Yardım konusunu içeren bir oturumu belirtir. PSSession nesnesini içeren bir değişken girin. Bu anahtar sözcük, dışa aktarılan komutlara ilişkin yardım konularını bulmak için Export-PSSession cmdlet'i tarafından kullanılır.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.HARİCİYARDIM

Komut dosyası veya işlev için XML tabanlı bir yardım dosyasını belirtir.

# .EXTERNALHELP <XML Help File>

.ExternalHelp anahtar sözcüğü, bir işlev veya komut dosyası XML dosyalarında belgelendiğinde gereklidir. Bu anahtar kelime olmadan Get-Help, işlev veya komut dosyası için XML tabanlı yardım dosyasını bulamaz.

.ExternalHelp anahtar kelimesi diğer yoruma dayalı yardım anahtar kelimelerine göre önceliklidir. .ExternalHelp mevcutsa, Get-Help, .ExternalHelp değeriyle eşleşen bir yardım konusu bulamasa bile yoruma dayalı yardımı görüntülemez. anahtar kelimesi.

İşlev bir modül tarafından dışa aktarılıyorsa .ExternalHelp anahtar sözcüğünün değerini yolu olmayan bir dosya adına ayarlayın. Get-Help, modül dizininin dile özgü bir alt dizininde belirtilen dosya adını arar. Bir işlev için XML tabanlı yardım dosyasının adı konusunda herhangi bir gereksinim yoktur, ancak en iyi uygulama aşağıdaki biçimi kullanmaktır:

<ScriptModule.psm1>-help.xml

İşlev bir modülde yer almıyorsa XML tabanlı yardım dosyasının yolunu ekleyin. Değer bir yol içeriyorsa ve yol kullanıcı arayüzü kültürüne özgü alt dizinler içeriyorsa, Get-Help dil geri dönüş standartlarına uygun olarak alt dizinlerde komut dosyası veya işlevin adını içeren bir XML dosyasını yinelemeli olarak arar. tıpkı bir modül dizininde olduğu gibi Windows için kurulmuştur.

Cmdlet yardımı XML tabanlı yardım dosyası biçimi hakkında daha fazla bilgi için bkz. Cmdlet Yardımı Nasıl Yazılır.

Otomatik oluşturulan içerik

Ad, sözdizimi, parametre listesi, parametre öznitelik tablosu, ortak parametreler ve açıklamalar, Get-Help cmdlet'i tarafından otomatik olarak oluşturulur.

İsim

Bir işlev yardımı konusunun Ad bölümü, işlev sözdizimindeki işlev adından alınır. Komut dosyası yardım konusunun Adı, komut dosyası dosya adından alınır. Adı veya büyük harf kullanımını değiştirmek için işlev sözdizimini veya komut dosyası dosya adını değiştirin.

Sözdizimi

Yardım konusunun Sözdizimi bölümü, işlev veya komut dosyası sözdiziminden oluşturulur. Yardım konusu sözdizimine bir parametrenin .NET türü gibi ayrıntı eklemek için ayrıntıyı sözdizimine ekleyin. Bir parametre türü belirtmezseniz Nesne türü varsayılan değer olarak eklenir.

Parametre Listesi

Yardım konusundaki parametre listesi, işlev veya komut söz diziminden ve .Parameter anahtar sözcüğünü kullanarak eklediğiniz açıklamalardan oluşturulur. İşlev parametreleri, yardım konusunun Parametreler bölümünde, işlev veya komut dosyası sözdiziminde göründükleri sırayla görünür. Parametre adlarının yazımı ve büyük harf kullanımı da sözdiziminden alınmıştır. .Parameter anahtar sözcüğü tarafından belirtilen parametre adından etkilenmez.

Ortak Parametreler

Ortak parametreler, hiçbir etkisi olmasa bile yardım konusunun sözdizimine ve parametre listesine eklenir. Ortak parametreler hakkında daha fazla bilgi için bkz. about_CommonParameters.

Parametre Özellik Tablosu

Get-Help, Get-HelpTam veya Parametre parametresini kullandığınızda görünen parametre nitelikleri tablosunu oluşturur >. Gerekli, Konum ve Varsayılan değer özelliklerinin değeri, işlev veya komut dosyası sözdiziminden alınır.

Varsayılan değerler ve Joker karakterleri kabul et değeri, işlev veya komut dosyasında tanımlansalar bile parametre öznitelik tablosunda görünmez. Kullanıcılara yardımcı olmak için bu bilgiyi parametre açıklamasında sağlayın.

Notlar

Yardım konusunun Açıklamalar bölümü, işlev veya komut dosyası adından otomatik olarak oluşturulur. İçeriğini değiştiremez veya etkileyemezsiniz.

Örnekler

Bir İşlev için Yoruma Dayalı Yardım

Aşağıdaki örnek işlev, yoruma dayalı yardım içerir:

function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
$name = $name + "." + $extension
$name

<#
.SYNOPSIS

Adds a file name extension to a supplied name.

.DESCRIPTION

Adds a file name extension to a supplied name.
Takes any strings for the file name or extension.

.PARAMETER Name
Specifies the file name.

.PARAMETER Extension
Specifies the extension. "Txt" is the default.

.INPUTS

None. You cannot pipe objects to Add-Extension.

.OUTPUTS

System.String. Add-Extension returns a string with the extension
or file name.

.EXAMPLE

PS> extension -name "File"
File.txt

.EXAMPLE

PS> extension -name "File" -extension "doc"
File.doc

.EXAMPLE

PS> extension "File" "doc"
File.doc

.LINK

http://www.fabrikam.com/extension.html

.LINK

Set-Item
#>
}

Sonuçlar aşağıdaki gibidir:

Get-Help -Name "Add-Extension" -Full

NAME

Add-Extension

SYNOPSIS

Adds a file name extension to a supplied name.

SYNTAX

Add-Extension [[-Name] <String>] [[-Extension] <String>]
[<CommonParameters>]

DESCRIPTION

Adds a file name extension to a supplied name. Takes any strings for the
file name or extension.

PARAMETERS

-Name
Specifies the file name.

Required?                    false
Position?                    0
Default value
Accept pipeline input?       false
Accept wildcard characters?

-Extension
Specifies the extension. "Txt" is the default.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type
"get-help about_commonparameters".

INPUTS
None. You cannot pipe objects to Add-Extension.

OUTPUTS

System.String. Add-Extension returns a string with the extension or
file name.

Example 1

PS> extension -name "File"
File.txt

Example 2

PS> extension -name "File" -extension "doc"
File.doc

Example 3

PS> extension "File" "doc"
File.doc

RELATED LINKS

http://www.fabrikam.com/extension.html
Set-Item

Fonksiyon Sözdizimindeki Parametre Açıklamaları

Bu örnek, parametre açıklamalarının işlev sözdizimine eklenmesi dışında öncekiyle aynıdır. Bu format en çok açıklamalar kısa olduğunda kullanışlıdır.

function Add-Extension
{
param
(

[string]
#Specifies the file name.
$name,

[string]
#Specifies the file name extension. "Txt" is the default.
$extension = "txt"
)

$name = $name + "." + $extension
$name

<#
.SYNOPSIS

Adds a file name extension to a supplied name.

.DESCRIPTION

Adds a file name extension to a supplied name. Takes any strings for the
file name or extension.

.INPUTS

None. You cannot pipe objects to Add-Extension.

.OUTPUTS

System.String. Add-Extension returns a string with the extension or
file name.

.EXAMPLE

PS> extension -name "File"
File.txt

.EXAMPLE

PS> extension -name "File" -extension "doc"
File.doc

.EXAMPLE

PS> extension "File" "doc"
File.doc

.LINK

http://www.fabrikam.com/extension.html

.LINK

Set-Item
#>
}

Bir Komut Dosyası için Yoruma Dayalı Yardım

Aşağıdaki örnek komut dosyası, yoruma dayalı yardım içerir. #> kapanışı ile Param ifadesi arasındaki boş satırlara dikkat edin. Param ifadesi olmayan bir komut dosyasında, yardım konusundaki son açıklama ile ilk işlev bildirimi arasında en az iki boş satır olmalıdır. Bu boş satırlar olmadan, Get-Help yardım konusunu komut dosyasıyla değil işlevle ilişkilendirir.

<#
.SYNOPSIS

Performs monthly data updates.

.DESCRIPTION

The Update-Month.ps1 script updates the registry with new data generated
during the past month and generates a report.

.PARAMETER InputPath
Specifies the path to the CSV-based input file.

.PARAMETER OutputPath
Specifies the name and path for the CSV-based output file. By default,
MonthlyUpdates.ps1 generates a name from the date and time it runs, and
saves the output in the local directory.

.INPUTS

None. You cannot pipe objects to Update-Month.ps1.

.OUTPUTS

None. Update-Month.ps1 does not generate any output.

.EXAMPLE

PS> .\Update-Month.ps1

.EXAMPLE

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

.EXAMPLE

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath `
C:\Reports\2009\January.csv
#>

param ([string]$InputPath, [string]$OutPutPath)

function Get-Data { }
...

Aşağıdaki komut komut dosyası yardımını alır. Betik, $env:Path ortam değişkeninde listelenen bir dizinde olmadığından, betik yardımını alan Get-Help komutunun betik yolunu belirtmesi gerekir.

Get-Help -Name .\update-month.ps1 -Full

# NAME

C:\ps-test\Update-Month.ps1

# SYNOPSIS

Performs monthly data updates.

# SYNTAX

C:\ps-test\Update-Month.ps1 [-InputPath] <String> [[-OutputPath]
<String>] [<CommonParameters>]

# DESCRIPTION

The Update-Month.ps1 script updates the registry with new data
generated during the past month and generates a report.

# PARAMETERS

-InputPath
Specifies the path to the CSV-based input file.

Required?                    true
Position?                    0
Default value
Accept pipeline input?       false
Accept wildcard characters?

-OutputPath
Specifies the name and path for the CSV-based output file. By
default, MonthlyUpdates.ps1 generates a name from the date
and time it runs, and saves the output in the local directory.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Accept wildcard characters?

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type,
"get-help about_commonparameters".

# INPUTS

None. You cannot pipe objects to Update-Month.ps1.

# OUTPUTS

None. Update-Month.ps1 does not generate any output.

Example 1

PS> .\Update-Month.ps1

Example 2

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv

Example 3

PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath
C:\Reports\2009\January.csv

# RELATED LINKS

XML Dosyasına Yönlendirme

Fonksiyonlar ve scriptler için XML tabanlı yardım konuları yazabilirsiniz. Yoruma dayalı yardımın uygulanması daha kolay olmasına rağmen, Güncelleştirilebilir Yardım için ve birden çok dilde yardım konuları sağlamak için XML tabanlı yardım gereklidir.

Aşağıdaki örnek, Update-Month.ps1 komut dosyasının ilk birkaç satırını göstermektedir. Betik, betiğin XML tabanlı yardım konusunun yolunu belirtmek için .ExternalHelp anahtar sözcüğünü kullanır.

.ExternalHelp anahtar sözcüğünün değerinin anahtar sözcükle aynı satırda göründüğünü unutmayın. Başka herhangi bir yerleşim etkisizdir.

# .ExternalHelp C:\MyScripts\Update-Month-Help.xml

param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...

Aşağıdaki örneklerde .ExternalHelp anahtar sözcüğünün bir işlevdeki üç geçerli yerleşimi gösterilmektedir.

function Add-Extension
{
# .ExternalHelp C:\ps-test\Add-Extension.xml

param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name
}

function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name

# .ExternalHelp C:\ps-test\Add-Extension.xml
}

# .ExternalHelp C:\ps-test\Add-Extension.xml
function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name
}

Farklı Bir Yardım Konusuna Yönlendirme

Aşağıdaki kod, PowerShell'deki yerleşik yardım işlevinin başlangıcından bir alıntı olup, her seferinde bir yardım metni ekranı görüntüler. Get-Help cmdlet'inin yardım konusu yardım işlevini açıkladığından, yardım işlevi, yönlendirmek için .ForwardHelpTargetName ve .ForwardHelpCategory anahtar sözcüklerini kullanır. kullanıcıyı Get-Help cmdlet yardım konusuna yönlendirin.

function help
{

<#
.FORWARDHELPTARGETNAME Get-Help
.FORWARDHELPCATEGORY Cmdlet
#>
[CmdletBinding(DefaultParameterSetName='AllUsersView')]
param(
[Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
[System.String]
${Name},
...

Aşağıdaki komut bu özelliği kullanır:

Get-Help -Name help

NAME

Get-Help

SYNOPSIS

Displays information about PowerShell cmdlets and concepts.
...

Ayrıca bakınız

about_Functions
about_Functions_Advanced_Parameters
about_Scripts
Cmdlet Yardımı Nasıl Yazılır

Yoruma Dayalı Yardım hakkında

Kısa açıklama

Uzun açıklama

Yoruma dayalı yardım için sözdizimi

İşlevlerde yoruma dayalı yardım için sözdizimi

Komut dosyalarında yoruma dayalı yardım için sözdizimi

Komut dosyası modüllerinde yoruma dayalı yardım için sözdizimi

Yoruma dayalı yardım anahtar kelimeleri

.ÖZET

.TANIM

.PARAMETRE

.ÖRNEK

.GİRİŞLER

.ÇIKIŞLAR

.NOTLAR

.BAĞLANTI

.BİLEŞEN

.ROL

.İŞLEVSELLİK

.FORWARDHELPTARGETNAME

.İLERİYARDIMKATEGORİSİ

.UZAKTAN YARDIMPRUNSPACE

.HARİCİYARDIM

Otomatik oluşturulan içerik

İsim

Sözdizimi

Parametre Listesi

Ortak Parametreler

Parametre Özellik Tablosu

Notlar

Örnekler

Bir İşlev için Yoruma Dayalı Yardım

Fonksiyon Sözdizimindeki Parametre Açıklamaları

Bir Komut Dosyası için Yoruma Dayalı Yardım

XML Dosyasına Yönlendirme

Farklı Bir Yardım Konusuna Yönlendirme

Ayrıca bakınız

İlgili makaleler