Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    text
    copied!<p>It works, you just gotta make sure you have the right headings. I've always put the comment block right above the function too. I'm not sure if it's supposed to work inside of the function or not.</p> <p>Below is an example of one of my functions that has a working doc help.</p> <pre><code>############################################################################## #.SYNOPSIS # Gets a COM object from the running object table (ROT) similar to GetObject # in Visual Basic. # #.DESCRIPTION # To maintain consistency with New-Object this cmdlet requires the -ComObject # parameter to be provided and the TypeName parameter is not supported. # #.PARAMETER TypeName # Not supported, but provided to maintain consistency with New-Object. # #.PARAMETER ComObject # The ProgID of a registered COM object, such as MapPoint.Application. # #.PARAMETER Force # If an existing object is not found, instead of writing an error, a new # instance of the object will be created and returned. # #.EXAMPLE # $olMailItem = 0 # Get-Object -ComObject Outlook.Application | %{$_.CreateItem($olMailItem).Display()} ############################################################################## function Get-Object { [CmdletBinding(DefaultParameterSetName='Net')] param ( [Parameter(ParameterSetName='Net', Position=1, Mandatory=$true)] [String]$TypeName, [Parameter(ParameterSetName='Com', Mandatory=$true)] [String]$ComObject, [Parameter()] [Switch]$Force ) if ( $TypeName ) { throw '-TypeName is not supported. Use -ComObject instead.' } if ( $ComObject ) { try { [System.Runtime.InteropServices.Marshal]::GetActiveObject($ComObject) } catch [System.Management.Automation.MethodInvocationException] { if ( $Force ) { New-Object -ComObject $ComObject } else { Write-Error "An active object of type $ComObject is not available." } } } } </code></pre>
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload