PowerShell_ISE utility function to add help tags

September 29, 2010 at 2:19 pm Leave a comment

The following is a utility function that adds a tag structure to make it easier to add help to your functions to be displayed by the Get-Help Cmdlet.

<#
.SYNOPSIS
  Inset tags to support the Get-Help Cmdlet
.DESCRIPTION
  Insert-FunctionHelpText inserts text at the current cursor position to provide
  a skeleton of tags which can then be edited to provide support for the function
  and the Get-Help Cmdlet.
.NOTES
  This is a useful function to be called from a menu added to the PowerShell-ISE
  Add-ons menu structure. 
.EXAMPLE
  Insert-FunctionHelpText
#>
function Insert-FunctionHelpText()
{
$psISE.CurrentFile.Editor.InsertText("<#
.SYNOPSIS
  Brief description of function.  Start with a verb.
.DESCRIPTION
  Full description of the function.  Start with <function name>
.PARAMETER parameterName
  Description of parameter
.INPUTS
  List .NET classes the function will accept as input.
.OUTPUTS
  List .NET classes the function will output.
.NOTES
  List information that does not easily fit into other parts of the structure.
.LINK
  about_function
.EXAMPLE
  function-name -parameter
#>
")
}

Advertisements

Entry filed under: PowerShell. Tags: , .

Finding files owned by a user, or they are on the ACL C# MessageBox with Time Out

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Trackback this post  |  Subscribe to the comments via RSS Feed


Calendar

September 2010
M T W T F S S
« Jul   Dec »
 12345
6789101112
13141516171819
20212223242526
27282930  

Most Recent Posts


%d bloggers like this: