Windows PowerShell Best Practices

Chapter 14. Documenting scripts

• Getting documentation from help

• Getting documentation from comments

• Using the AST parser

• Additional resources

One of the great things about Windows PowerShell is the way that it provides the ability to document scripts. In this chapter, we look at different ways of obtaining documentation. We begin with examining documentation from help, and then we move to different ways of getting documentation from the scripts themselves.

Getting documentation from help

There are many reasons for documenting scripts. It might be due to compliance requirements, for ease of use, or for change control. The easiest way to provide script documentation is to obtain it from the script itself. While there are several different ways of incorporating ...