如何为PowerShell的cmdlet示例设置多色显示以提升可读性？

This is such a smart request—color-coding help output turns wall-of-text examples into something way easier to scan and understand. You’ve got two main paths to implement this, plus ways to add multiple color schemes for different environments (light/dark terminals, etc.).

Option 1: Build Your Own Custom Colorized Help Function #

If you want full control over exactly which parts get colored, you can write a simple function that parses Get-Help output and applies colors using Write-Host. Here’s a working example with two built-in schemes:

function Get-ColorizedHelp {
    param(
        [Parameter(Mandatory=$true)]
        [string]$Command,
        [ValidateSet('Dark', 'Light')]
        [string]$Scheme = 'Dark'
    )

    # Define color schemes for different terminal themes
    $colorSchemes = @{
        Dark = @{
            ExampleHeader = 'Cyan'
            UserCommand = 'Green'
            CommandOutput = 'Gray'
            DescriptionText = 'White'
        }
        Light = @{
            ExampleHeader = 'DarkBlue'
            UserCommand = 'DarkGreen'
            CommandOutput = 'Black'
            DescriptionText = 'DarkGray'
        }
    }
    $activeColors = $colorSchemes[$Scheme]

    # Fetch help content and process line by line
    $helpLines = Get-Help $Command -Examples | Out-String -Stream

    foreach ($line in $helpLines) {
        switch -Regex ($line) {
            # Match example headers like "EXAMPLE 1:"
            '^EXAMPLE \d+:' { Write-Host $line -ForegroundColor $activeColors.ExampleHeader }
            # Match user input lines like "PS C:\> Get-Process"
            '^PS [A-Z]:\\>' { Write-Host $line -ForegroundColor $activeColors.UserCommand }
            # Match indented output lines from examples
            '^    ' { Write-Host $line -ForegroundColor $activeColors.CommandOutput }
            # Default for all other text (descriptions, etc.)
            default { Write-Host $line -ForegroundColor $activeColors.DescriptionText }
        }
    }
}

To use it, just run:

# Dark scheme (default)
Get-ColorizedHelp Get-Process -Examples
# Light scheme for bright terminals
Get-ColorizedHelp Get-Process -Scheme Light

You can tweak the regex patterns and color values to match exactly what you want to highlight—add more schemes for things like solarized themes too!

Option 2: Use a Community Module for Out-of-the-Box Support #

If you don’t want to build something from scratch, the PowerShell community has pre-built modules that add color to help (and other) output. One popular option is PSColor:

1. Install the module first (you’ll need to allow script execution if you haven’t already):

   Install-Module PSColor -Scope CurrentUser -Force
   

2. Import it into your PowerShell profile so it loads automatically every time you open a session:

   # Add this line to your $PROFILE file
   Import-Module PSColor
   

3. Configure your preferred colors (again, add this to your profile for persistence):

   $PSColor.Help.Example = 'Cyan'       # Example headers
   $PSColor.Help.Command = 'Green'      # User input commands
   $PSColor.Help.Description = 'Gray'   # Descriptive text
   $PSColor.Help.Output = 'Yellow'      # Command output in examples
   

Once set up, running Get-Help Get-Process -Examples will automatically show color-coded output without needing to use a custom function.

Bonus: Add Easy Color Scheme Switching #

To make switching between schemes even simpler, you can write a small helper function to swap your PSColor configs on the fly:

function Set-HelpColorScheme {
    param(
        [ValidateSet('Dark', 'Light', 'Solarized')]
        [string]$Scheme
    )

    $schemeConfigs = @{
        Dark = @{
            Example = 'Cyan'
            Command = 'Green'
            Description = 'Gray'
            Output = 'Yellow'
        }
        Light = @{
            Example = 'DarkBlue'
            Command = 'DarkGreen'
            Description = 'DarkGray'
            Output = 'DarkRed'
        }
        Solarized = @{
            Example = 'Blue'
            Command = 'Green'
            Description = 'Yellow'
            Output = 'Magenta'
        }
    }

    if ($schemeConfigs.ContainsKey($Scheme)) {
        $config = $schemeConfigs[$Scheme]
        $PSColor.Help.Example = $config.Example
        $PSColor.Help.Command = $config.Command
        $PSColor.Help.Description = $config.Description
        $PSColor.Help.Output = $config.Output
        Write-Host "Switched to $Scheme help color scheme" -ForegroundColor $config.Example
    }
}

Now you can switch schemes in one command:

Set-HelpColorScheme Solarized

内容的提问来源于stack exchange，提问作者Alasdair