O'Reilly logo

Mastering Windows PowerShell Scripting by Brenton J.W. Blawat

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

# commenting headers

The first recommendation is to create headers for the detailed tracking information about the PowerShell script itself. Headers can track information about the script's creation, authors, changes, and other useful information that will enable you to quickly determine what the script is doing. PowerShell has built-in block comment support, which integrates with the get-help cmdlet.

The required components for this include:

  • Comment block location: The comment block must be the first item defined at the top of your script. If you use parameter blocks, you will need to specify the parameter blocks after the comment block.
  • Start comment block: In order to integrate with the help system, you need to specify the starting of the comment ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required