Import-MarkdownModuleFile

Markdown modül dosyasını bir ModuleHelp nesnesine aktarır.

Syntax

Path (Varsayılan)

Import-MarkdownModuleFile
    [-Path] <string[]>
    [<CommonParameters>]

LiteralPath

Import-MarkdownModuleFile
    -LiteralPath <string[]>
    [<CommonParameters>]

Description

komutu modül yardımı içeren Markdown dosyalarını içeri aktarır ve modulehelp nesneleri oluşturur. ModuleHelp nesnesi, farklı biçimlere dışarı aktarmak için kullanılabilecek yardım içeriğinin yapılandırılmış bir gösterimidir.

Örnekler

Örnek 1 - Dönüştür

Import-MarkdownModuleFile .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Metadata      : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
                0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title         : Microsoft.PowerShell.PlatyPS Module
Module        : Microsoft.PowerShell.PlatyPS
ModuleGuid    : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description   : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale        : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics   : Microsoft.PowerShell.PlatyPS.Model.Diagnostics

Parametreler

-LiteralPath

Markdown dosyalarını içeren bir veya daha fazla konumun yolunu belirtir. LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.

Daha fazla bilgi için bkz. about_Quoting_Rules.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:PSPath, LP

Parametre kümeleri

LiteralPath
Position:Named
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Path

Bir öğenin yolunu belirtir. Bu cmdlet öğeyi belirtilen konumda alır. Joker karakterlere izin verilir. Bu parametre gereklidir, ancak Path parametre adı isteğe bağlıdır.

Geçerli konumu belirtmek için nokta (.) kullanın. Geçerli konumdaki tüm öğeleri belirtmek için joker karakteri (*) kullanın.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

Path
Position:0
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

String

Çıkışlar

Microsoft.PowerShell.PlatyPS.ModuleFileInfo