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 ...
Get Learn PowerShell Scripting in a Month of Lunches, 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.
