Skriva kommentarsbaserade hjälpavsnitt

Du kan skriva kommentarsbaserade hjälpavsnitt för funktioner och skript med hjälp av särskilda nyckelord för hjälpkommentarer.

Cmdleten visar kommentarsbaserad hjälp i samma format som den visar Get-Help de cmdlet-hjälpavsnitt som genereras från XML-filer. Användare kan använda alla parametrar för , till Get-Help exempel Detaljerad, Fullständig, Exempel och Online, för att visa funktionen och skripthjälpen.

Du kan också skriva XML-baserade hjälpavsnitt för skript och funktioner och använda nyckelorden Hjälpkommentar för att omdirigera användare till XML-baserade ämnen eller andra ämnen.

I det här avsnittet

Syntax för Comment-Based hjälp Beskriver syntaxen för kommentarsbaserad hjälp.

Nyckelord för kommentarsbaserad hjälp Visar en lista över nyckelorden i kommentarsbaserad hjälp.

Lägga Comment-Based hjälp i Functions Visar var du placerar kommentarsbaserad hjälp för en funktion.

Lägga Comment-Based hjälp i skript Visar var du placerar kommentarsbaserad hjälp för ett skript.