PowerShell on Ubuntu: Adding Comment Based Help
Hi, my name is Wes Holton and welcome back to my series on running Microsoft’s PowerShell on Ubuntu Linux. This series is aimed at the IT professional or hobbyist who may be new to PowerShell, Linux, or both.
In today’s video, we will finish up our three part series on creating custom functions in PowerShell.
During this series, we started with an idea and when we are finished, we will have our own custom PowerShell function that behaves much like a native cmdlet by taking parameters and containing its own comment based help. That comment based help is the subject of today's video.
Let's face it... sometimes working with a system or solution that someone else has written can be confusing, especially if you're working in a command-line and there's not a lot of "discoverability" i.e. menus and buttons to click. That's where Help files can come in really handy.
In today's video, we are going to look at adding comment based help to the function that we've been working on. As I've discussed in a previous video, one of the awesome aspects of Powershell is the HELP. The help files in Powershell are somewhat similar to man pages in a Unix-based system. If you would like to learn more about the PowerShell help system, I have another video all about it linked in the comment section.
Adding help to your script or function not only gives it nice, polished feel, but makes it easier for other admins and support staff to use in the future.
For more info, go to http://technet.microsoft.com/en-us/library/hh847834.aspx
In my next video, we will work on pulling information from the internet for use in a profile script or function
If you found this video helpful, and you would like to see more like it, be sure to give it a like and hit the subscribe button as well.
Leave a comment if you have any questions or there’s something that you’d like me to cover in a future video.
As always, you can reach me on twitter at @holtonwes. I also have a blog at wshwes.blogspot.com. And until next time, POSH ON!
DOWNLOAD VISUAL STUDIO CODE
SOURCE FOR TODAY'S SCRIPT
And as always, POSH ON!!