Expand Minimize

Exported CmdLets should include comment help

Comments should be provided which supple the help context of the Exported CmdLet for use with Get-Help.

CheckId SPC059108
TypeName ProvideCmdLetHelp
Severity Information
Type PowerShell File

Bad Practice

function Verb-Noun {
Good Practice
       Short description
       Long description
       Example Usage
       Another Example Usage
       Returned Values
       Extra information
       Parent component
       CmdLets Role
       The functional description of the CmdLet
function Verb-Noun {

Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.