Skip to Main Content
PowerShell in Depth
book

PowerShell in Depth

by Don Jones, Jeffery Hicks, Richard Siddaway
February 2013
Intermediate to advanced content levelIntermediate to advanced
632 pages
20h 20m
English
Manning Publications
Content preview from PowerShell in Depth

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 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 is that many people try to develop their own way of delivering help. This is a bad idea because ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

PowerShell in Depth, Second Edition

PowerShell in Depth, Second Edition

Don Jones, Richard Siddaway, Jeffery Hicks
PowerShell in Practice

PowerShell in Practice

Richard Siddaway

Publisher Resources

ISBN: 9781617290558Publisher SupportOtherPublisher WebsiteSupplemental ContentPurchase Link