Parameter Help auto generation in PowerShell Functions

Offen

#1,931 erstellt am 20.6.2023 4 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 30/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: powershell
Bereich: tooling

Rechercherichtung

Es werden keine Dateien oder Tests genannt. Beginne damit, den Generator für die Parameterhilfe und die Einstellungsdefinitionen für die PowerShell-Erweiterung zu finden; vergleiche dann die vorhandene Vorlage mit dem vorgeschlagenen Feld .OUTPUTS und der Einstellung generatorTemplateFields. Erledigt ist die Aufgabe, wenn entweder .OUTPUTS zur generierten Hilfe hinzugefügt wird oder konfigurierbare Vorlagenfelder dokumentiert und implementiert werden, jeweils mit Testabdeckung für das ausgewählte Verhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Issue-Enhancement Up for Grabs

Prerequisites

I have written a descriptive issue title.
I have searched all issues to ensure it has not already been reported.

Summary

If you go above the parameter block of a function and write "##" the parameter help template is pre-generated automatically by the PowerShell Extension. However currently this generates:

<#
    .SYNOPSIS
    Short description
    
    .DESCRIPTION
    Long description
    
    .PARAMETER exampleParam
    Parameter description
    
    .EXAMPLE
    An example
    
    .NOTES
    General notes
    #>

However, it is best practice to also specify the return value of your function by using ".OUTPUTS", therefore it would be nice if this could be added to the default template / if the default template could be configured in the settings.json.

Proposed Design

This could be accomplished by either:

Static Design

Add ".OUTPUTS" to the current template

Dynamic Design

Add the possibility to specify the fields in the template in a list like:

 "powershell.extentention" : {
      "parameterHelp" : {
           "generatorTemplateFields" : [
               ".SYNOPSIS", ".DESCRIPTION", ".PARAMETER", ".EXAMPLE", ".NOTES", ".OUTPUTS"
            ]
      }
 }

Vorherrschende Sprache: C#
Sterne: 2.2k
Forks: 415
Ø Merge: 13 Std. 1 Min.
Gemergte PRs (30 T.): 2

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus PowerShell/PSScriptAnalyzer

Add EditorConfig `.editorconfig` to project Offen

Up-for-Grabs

Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 78/100

PowerShell/PSScriptAnalyzer#2213 · 2 Kommentare · Erstellt am 11.9.2026
PSUseConsistentIndentation flattens the indentation of commented-out code Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100

PowerShell/PSScriptAnalyzer#2217 · 1 Kommentar · Erstellt am 18.9.2026
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 70/100

PowerShell/PSScriptAnalyzer#2216 · 2 Kommentare · Erstellt am 18.9.2026
`Invoke-Formatter -Range` silently drops corrections after earlier fixes shift text Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100

PowerShell/PSScriptAnalyzer#2211 · Erstellt am 24.8.2026
`PSPlaceOpenBrace` and `PSPlaceCloseBrace` leave trailing whitespace when expanding one-line blocks Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 70/100

PowerShell/PSScriptAnalyzer#2210 · Erstellt am 24.8.2026

Alle Issues in PowerShell/PSScriptAnalyzer