{"id":2318,"date":"2012-05-16T09:47:58","date_gmt":"2012-05-16T13:47:58","guid":{"rendered":"http:\/\/jdhitsolutions.com\/blog\/?p=2318"},"modified":"2012-05-16T09:58:23","modified_gmt":"2012-05-16T13:58:23","slug":"introducing-the-scriptinghelp-powershell-module","status":"publish","type":"post","link":"https:\/\/jdhitsolutions.com\/blog\/powershell\/2318\/introducing-the-scriptinghelp-powershell-module\/","title":{"rendered":"Introducing the ScriptingHelp PowerShell Module"},"content":{"rendered":"

\"\"<\/a>Over the last few weeks I've posted articles on the different parameter validation options in Windows PowerShell. More than one person suggested consolidating the articles. That seemed like a good idea. There were a variety of ways to handle this but I wanted something more PowerShell-oriented. Then I realized, why not produce PowerShell About topics? I could create a module that primarily was a collection of about topics on scripting in PowerShell. Import the module and you get the documentation. <\/p>\n

In fact, this is a slick idea you might want to take advantage of: create a PowerShell module with nothing but documentation delivered via About_* files. If you are spending a lot of time in the shell, stay there! But before I get sidetracked, let's look at the module I'm calling ScriptingHelp.<\/p>\n

As I said the module is mostly a collection of About_* topics based on some of my blog articles. Then I realized I wanted to make it easier to expose them so I threw together a brief function called Get-ScriptingHelp.<\/p>\n

\"\"<\/a><\/p>\n

The About topics are edited and revised versions of material previously posted on my blog.<\/p>\n

\"\"<\/a><\/p>\n

I plan on contributing additional content over time based on previous blog articles, suggestions or anything that comes to mind that I think can help you write more effective PowerShell scripts and functions.<\/p>\n

To that end, I have also included a function to help you start scripting even faster. It is a new function wizard called Invoke-FunctionWizard. When you run the wizard, you will be prompted for information about your new function such as its name and parameter information. The wizard will then write a string object with the skeletal outline of your new function, complete with comment-based help. If you run the wizard in the ISE it will automatically insert the text into the currently open file. <\/p>\n

But perhaps you'd like to see all of this in action.<\/p>\n