Test-MarkdownCommandHelp
Markdown yardım dosyasının yapısını test edin.
Syntax
Item
Test-MarkdownCommandHelp
[-Path] <string[]>
[-DetailView]
[<CommonParameters>]
Literal
Test-MarkdownCommandHelp
-LiteralPath <string[]>
[-DetailView]
[<CommonParameters>]
Description
Bu komut bir Markdown yardım dosyasını okur ve gerekli öğelerin uygun sırada olup olduğunu denetleyerek yardım içeriğinin yapısını doğrular. Dosya doğrulamayı geçerse komut $true döndürür.
DetailView parametresi, daha ayrıntılı doğrulama bilgilerini görüntülemek için kullanılabilir.
Örnekler
Örnek 1 - Markdown yardım dosyasını test etme
Bu örnekte, Markdown Modülü yardım dosyasının yapısını test ediyoruz. Komut bir Markdown Komutu yardım dosyasını test etmek beklediğinden bu test başarısız olur. Çıkış, DetailView parametresinden bekleyebileceğiniz bilgi türünü gösterir.
Test-MarkdownCommandHelp .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md -DetailView
Test-MarkdownCommandHelp
Valid: False
File: D:\Git\PS-Src\platyPS\v2docs\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Messages:
PASS: First element is a thematic break
FAIL: SYNOPSIS not found.
FAIL: SYNTAX not found.
FAIL: DESCRIPTION not found.
FAIL: EXAMPLES not found.
FAIL: PARAMETERS not found.
FAIL: INPUTS not found.
FAIL: OUTPUTS not found.
FAIL: NOTES not found.
FAIL: RELATED LINKS not found.
Parametreler
-DetailView
Komutuna ayrıntılı doğrulama bilgilerini çıktı olarak göndermesini sağlar.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | False |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Ö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 |
-LiteralPath
Bir veya daha fazla komut markdown dosyasının 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
Literal
| Position: | Named |
| Zorunlu: | True |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Path
Test etmek için Markdown yardım dosyasının yolu.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
Parametre kümeleri
Item
| Position: | 0 |
| Zorunlu: | True |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | True |
| 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.