PowerShell Core for Linux Administrators Cookbook

How it works...

The formatting of the PowerShell help documentation is very specific. PowerShell, even without what you just added, would make Get-Help possible on the cmdlet, although the help information would only show the parameters, which parameter is mandatory, and so on. If you would like to provide the user with more information on each of the parameters (which is recommended, by the way), add this help documentation.

PowerShell typically looks for this large, formatted comment block before the function declaration or right after it. While it is possible that PowerShell recognizes these in more places, it is recommended that the help document be added right before the function declaration or right after.

PowerShell also recognizes ...