Learn PowerShell Core 6.0

Help-driven development

In order to create proper help content, you should incorporate it into your function and module development. While at the beginning, you might want to write comment-based help, consider writing file-based help content for larger projects, instead.

If you adopt the same style for all functions that you create, integrating help content early on will be very easy. You need to document what you did, anyway, so why not write it in your help? An example is as follows:

function Get-CommentBasedHelp {    <#        .SYNOPSIS            This contains a brief description        .DESCRIPTION            This contains a long description        .EXAMPLE            Get-CommentBasedHelp            These are examples for all parameter sets        .NOTES This contains additional fluff like the author, changelog, ...