Windows PowerShell™ 2.0 Best Practices

Chapter 10. Designing Help for Scripts

• Adding Help Documentation to a Script with Single-Line Comments 331

• Using the Here-String for Multiple-Line Comments 335

• Using Multiple-Line Comment Tags in Windows PowerShell 2.0 355

• The 13 Rules for Writing Effective Comments 357

• Additional Resources 372

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 ...