Comment-based help is the easiest way to create help for the scripts that you write. If you write comment-based help in your function, then the Get-Help cmdlet will show you help for the function in the same way as it shows the help for any other PowerShell native cmdlet. So, whenever you are writing an advanced function, you should include comment-based help so that end users can utilize the help of the Get-help cmdlet to work with the function.
Before we go ahead and dive into comment-based help, I would like to draw your attention to the following fact.
You have just seen the preceding function where I created a dynamic variable to accept the user id, vmName, and environment where I can create VMs. Note that, in this function, I did not write any help, so what happens if I try to run Get-Help on this function? Let's see.
Wow! It gives a short description. Let's try the –Full version.
Pretty amazing right? It provides help in the same format as it provides for other...
