Chapter 29. Writing help
This chapter covers
- Writing comment-based help
- Writing About content help
- Writing XML-based help
As you develop your own scripts and functions, or even if you dive into .NET Framework programming and create your own binary cmdlets, you’ll doubtless want to include help with them. PowerShell’s help system (see chapter 3) is a crucial feature for shell users, giving them the ability to discover, learn, and use commands. Without help, your functions and cmdlets become essentially invisible, unlearnable, and unusable. Fortunately, PowerShell makes it relatively easy to write your own help.
One thing we’ve seen in recent Scripting Games (a competition originally run by Microsoft and now hosted by PowerShell.org; see ...
Get PowerShell in Depth, Second Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
