Windows PowerShell Best Practices

Chapter 9. Designing help for scripts

• Adding help documentation to a script with single-line comments

• Using multiple-line comment tags in Windows PowerShell 4.0

• Using comment-based help

• The 13 rules for writing effective comments

• Additional resources

Although well-written code is easy to understand, easy to maintain, and easy to troubleshoot, it can still benefit from well-written help documentation. Well-written help documentation can list assumptions that were made when the script was written, such as the existence of a particular folder or the need to run as an administrator. It also documents dependencies, such as relying on a particular version of the Microsoft .NET Framework. Good documentation is a sign of a professional at work because it not ...