Add comment in SamplePSReadLineProfile.ps1

[sethvs]

PR Summary

Add comment in SamplePSReadLineProfile.ps1 so that the purpose of the code block is more clear.

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Make sure you've added one or more new tests
• User-facing changes
  • Not Applicable
  • OR
  • Documentation needed at PowerShell-Docs
    • Doc Issue filed:

Microsoft Reviewers: Open in CodeFlow

[lzybkr]

This smart quote example can be pretty annoying sometimes. I was considering replacing it with something simpler. This is what I'm currently using and am finding it less annoying even though it does less:

Set-PSReadLineKeyHandler -Key '"',"'" `
                         -BriefDescription SmartInsertQuote `
                         -LongDescription "Insert paired quotes if not already on a quote" `
                         -ScriptBlock {
    param($key, $arg)

    $quote = $key.KeyChar

    $selectionStart = $null
    $selectionLength = $null
    [Microsoft.PowerShell.PSConsoleReadLine]::GetSelectionState([ref]$selectionStart, [ref]$selectionLength)

    $line = $null
    $cursor = $null
    [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$line, [ref]$cursor)

    # If text is selected, just quote it without any smarts
    if ($selectionStart -ne -1)
    {
        [Microsoft.PowerShell.PSConsoleReadLine]::Replace($selectionStart, $selectionLength, $quote + $line.SubString($selectionStart, $selectionLength) + $quote)
        [Microsoft.PowerShell.PSConsoleReadLine]::SetCursorPosition($selectionStart + $selectionLength + 2)
        return
    }

    if ($cursor -lt $line.Length -and $line[$cursor] -eq $quote) {
        # Just move the cursor, the current character is most likely a closing quote.
        [Microsoft.PowerShell.PSConsoleReadLine]::SetCursorPosition($cursor + 1)
        return
    }

    # Only insert matching quotes if doing so avoids adding additional errors.
    $parseErrors = $null
    [Microsoft.PowerShell.PSConsoleReadLine]::GetBufferState([ref]$null, [ref]$null, [ref]$parseErrors, [ref]$null)

    $insertSingleQuoteLine = $line.Substring(0, $cursor) + $quote
    if ($cursor -le $line.Length) {
        $insertSingleQuoteLine += $line.Substring($cursor)
    }

    $newParseErrors = $null
    $null = [Parser]::ParseInput($insertSingleQuoteLine, [ref]$null, [ref]$newParseErrors)
    if ($parseErrors.Length -ge $newParseErrors.Length) {
        [Microsoft.PowerShell.PSConsoleReadLine]::Insert("$quote")
    } else {
        # Insert matching quotes, move cursor to be in between the quotes
        [Microsoft.PowerShell.PSConsoleReadLine]::Insert("$quote$quote")
        [Microsoft.PowerShell.PSConsoleReadLine]::SetCursorPosition($cursor + 1)
    }
}

[daxian-dbw]

@lzybkr Do you want to submit a PR to replace the existing one in SamplePSReadLineProfile.ps1?