Skip to Main Content
Learn PowerShell Scripting in a Month of Lunches, Second Edition
book

Learn PowerShell Scripting in a Month of Lunches, Second Edition

by James Petty, Jeffery Hicks, Don Jones
April 2024
Beginner to intermediate content levelBeginner to intermediate
336 pages
8h 51m
English
Manning Publications
Content preview from Learn PowerShell Scripting in a Month of Lunches, Second Edition

14 Simple help: Making a comment

One of the things we all love about PowerShell is its help system. Like Linux’s man pages, PowerShell’s help files can provide information, examples, instructions, and more. So, we want to provide help with the tools we create—and you should too. You have two ways of doing so.

First is the easiest solution, which is comment-based help. You simply put the help files at the top of your scripts and functions, and PowerShell will interpret these as the help files. Second, an external help file is generally written in Markdown format. You can use modules such as PlatyPS to help create these files. For now, we’ll use the simpler, single-language, comment-based help inside your function.

14.1 Where to put your help ...

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

Learn PowerShell Scripting in a Month of Lunches

Learn PowerShell Scripting in a Month of Lunches

Jeffery Hicks, Don Jones
Learn PowerShell in a Month of Lunches, Fourth Edition

Learn PowerShell in a Month of Lunches, Fourth Edition

Tyler Leonhardt, Travis Plunk, James Petty

Publisher Resources

ISBN: 9781633438989Supplemental ContentPublisher SupportOtherPublisher WebsiteSupplemental ContentPurchase Link