Condividi tramite

Test-MarkdownCommandHelp

Modulo:
Microsoft.PowerShell.PlatyPS Module

Verifica la struttura di un file della Guida markdown.

Sintassi

Item 

Test-MarkdownCommandHelp
    [-Path] <string[]>
    [-DetailView]
    [<CommonParameters>]

Literal 

Test-MarkdownCommandHelp
    -LiteralPath <string[]>
    [-DetailView]
    [<CommonParameters>]

Descrizione

Questo comando legge un file della Guida markdown e convalida la struttura del contenuto della Guida controllando la presenza di elementi necessari nell'ordine corretto. Il comando restituisce $true se il file supera la convalida. Il parametro DetailView può essere usato per visualizzare informazioni di convalida più dettagliate.

Esempio

Esempio 1 - Testare un file della Guida markdown

Per questo esempio viene testata la struttura di un file della Guida del modulo Markdown. Questo test ha esito negativo perché il comando prevede di testare un file della Guida del comando Markdown. L'output mostra il tipo di informazioni che è possibile prevedere dal parametro DetailView.

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.

Parametri

-DetailView

Indica al comando di restituire informazioni dettagliate sulla convalida.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-LiteralPath

Specifica un percorso di uno o più file markdown dei comandi. Il valore di LiteralPath viene usato esattamente come viene digitato. Nessun carattere viene interpretato come metacaratteri. Se il percorso include caratteri di escape, racchiudilo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.

Per altre informazioni, vedere about_Quoting_Rules.

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:PSPath, UP

Set di parametri

Literal
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Path

Percorso del file della Guida markdown da testare.

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

Item
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

String

Output

Boolean

Microsoft.PowerShell.PlatyPS.MarkdownCommandHelpValidationResult