PowerShell.com
Library » Script Library » Misc » Function to insert help tags in PowerShell_ISE

Function to insert help tags in PowerShell_ISE

Previous | Next | View all files | View Slideshow
posted by Brent Challis
02-14-2011
Downloads: 294
File size: 6.4kB
Views: 1,404
Embed
Function to insert help tags in PowerShell_ISE
  1. <# 
  2. .SYNOPSIS 
  3.   Inset tags to support the Get-Help Cmdlet 
  4. .DESCRIPTION 
  5.   Insert-FunctionHelpText inserts text at the current cursor position to provide 
  6.   a skeleton of tags which can then be editted to provide support for the function 
  7.   and the Get-Help Cmdlet. 
  8. .NOTES 
  9.   This is a useful function to be called from a menu added to the PowerShell-ISE 
  10.   Add-ons menu structure.   
  11. .EXAMPLE 
  12.   Insert-FunctionHelpText 
  13. #> 
  14. function Insert-FunctionHelpText() 
  15. { 
  16. $psISE.CurrentFile.Editor.InsertText("<# 
  17.     .SYNOPSIS 
  18.         A brief description of the function or script. This keyword can be used 
  19.         only once in each topic. 
  20.  
  21.     .DESCRIPTION 
  22.         A detailed description of the function or script. This keyword can be 
  23.         used only once in each topic. 
  24.  
  25.     .PARAMETER  <Parameter-Name> 
  26.         The description of a parameter. You can include a Parameter keyword for 
  27.         each parameter in the function or script syntax. 
  28.  
  29.     .EXAMPLE 
  30.         A sample command that uses the function or script, optionally followed 
  31.         by sample output and a description. Repeat this keyword for each example. 
  32.  
  33.     .INPUTS 
  34.         The Microsoft .NET Framework types of objects that can be piped to the 
  35.         function or script. You can also include a description of the input  
  36.         objects. 
  37.  
  38.     .OUTPUTS 
  39.         The .NET Framework type of the objects that the cmdlet returns. You can 
  40.         also include a description of the returned objects. 
  41.  
  42.     .NOTES 
  43.         Additional information about the function or script. 
  44.  
  45.     .LINK 
  46.         The name of a related topic. Repeat this keyword for each related topic. 
  47.  
  48.         This content appears in the Related Links section of the Help topic. 
  49.  
  50.     .COMPONENT 
  51.         The technology or feature that the function or script uses, or to which 
  52.         it is related. This content appears when the Get-Help command includes 
  53.         the Component parameter of Get-Help. 
  54.  
  55.     .ROLE 
  56.         The user role for the Help topic. This content appears when the Get-Help 
  57.         command includes the Role parameter of Get-Help. 
  58.  
  59.     .FUNCTIONALITY 
  60.         The intended use of the function. This content appears when the Get-Help 
  61.         command includes the Functionality parameter of Get-Help. 
  62.  
  63.     .FORWARDHELPTARGETNAME <Command-Name> 
  64.         Redirects to the Help topic for the specified command. You can redirect 
  65.         users to any Help topic, including Help topics for a function, script, 
  66.         cmdlet, or provider.  
  67.  
  68.     .FORWARDHELPCATEGORY  <Category> 
  69.         Specifies the Help category of the item in ForwardHelpTargetName. 
  70.         Valid values are Alias, Cmdlet, HelpFile, Function, Provider, General, 
  71.         FAQ, Glossary, ScriptCommand, ExternalScript, Filter, or All. Use this 
  72.         keyword to avoid conflicts when there are commands with the same name. 
  73.  
  74.     .REMOTEHELPRUNSPACE <PSSession-variable> 
  75.         Specifies a session that contains the Help topic. Enter a variable that 
  76.         contains a PSSession. This keyword is used by the Export-PSSession 
  77.         cmdlet to find the Help topics for the exported commands. 
  78.  
  79.     .EXTERNALHELP  <XML Help File Path> 
  80.         Specifies the path to an XML-based Help file for the script or function.   
  81.  
  82. #> 
  83. ") 

The function will insert the comment tags to provide a template for the information required by the Get-Help Cmdlet.  I include this function on my PowerShell_ISE profile and have a menu item added to call it.

Copyright 2012 PowerShell.com. All rights reserved.