Best Practice: It is recommended to use an English singular noun for cmdlet, do not use plural noun. Explanation: PowerShell cmdlets use the syntax Verb-Noun. Example: Get–Service (“Get” is the verb, “Service” is the noun). Following this syntax convention makes more intuitive what the scope of the cmdlet. (ex: with Get-Service, we know that the cmdlet… Read More »
Best Practice: It is recommended to avoid excessive comments (over-commenting). Explanation: The code should be enough self-explanatory so that no comments at all are needed. I would recommend to refactor the code instead of adding comment to the code logic. For example, if you have block of code of 15 lines and you want to explain… Read More »
Best Practice: It is recommended to use CIM cmdlets, not WMI cmdlets. Explanation: WMI cmdlets are considered obsolete but if you stil use legacy PowerShell v1/2 you could use them. Since Powershell v3 CIM new cmdlets are available.
|
1 2 3 4 5 6 7 |
WMI (Not recommended) (Get-WmiObject -ClassName win32_operatingsystem).LastBootUpTime 20150522095242.375199+120 CIM (Recommended) (Get-CimInstance -ClassName win32_operatingsystem).LastBootUpTime 22 May 2015 09:52:42 |
Microsoft is not spending time on WMI cmdlets, it means that no additional development or improvement… Read More »
Best Practice: It is recommended to avoid Write-Host (unless your goal is to write to the host only).
|
1 |
Write-Host -Object 'Successfully completed' |
Explanation: Write-Host is like a picture sent to the screen, it sends to the host and does not return any objects, it is not possible to export or convert in a specific format. Write-Host has too many limitations.… Read More »
Best Practice: It is recommended to use named parameter in your scripts and avoid positional and partial (=truncated, shortened, abbreviated) parameter names in your scripts. Explanation: Note: The same logic also could be applied to attribute parameters (line 5)
|
1 2 3 4 5 6 7 8 |
function Get-Something { Param ( [Parameter(Mandatory=$true, ValueFromPipeline=$true)] [string[]]$Path ) } |
=== Additional Information When using positional parameters, the syntax can be more difficult to read especially with there… Read More »
Best Practice: It is recommended to use full cmdlet in your scripts and alias in an interactive console (never use alias in your scripts). Explanation: Script (use cmdlet) Using cmdlets in a script makes the code more clear and consistent when shared with other people. === Interactive (use alias) Using alias in an interactive console is useful to… Read More »