powershell

Best Practices

• Use Set-StrictMode -Version Latest to catch common errors
• Set $ErrorActionPreference = 'Stop' for fail-fast behavior
• Use approved verbs (Get-Verb) for function names
• Include comment-based help with .SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE
• Use [CmdletBinding()] on all functions for common parameters (-Verbose, -WhatIf)
• Use [Parameter()] attributes with Mandatory, Position, and HelpMessage
• Prefer Write-Host with -ForegroundColor for user output, Write-Verbose for debug
• Use try/catch/finally for error handling with specific exception types
• Use splatting (@params) for long parameter lists
• Test paths with Test-Path before file operations
• Use Join-Path instead of string concatenation for file paths
• Prefer PowerShell 7+ features (ternary operator, null-coalescing, parallel foreach)
• Use
• Return typed objects, not formatted strings
• Use Write-Error -ErrorAction Stop for terminating errors

Documentation Sources