支持自定义PowerShell cmdlet的Get-Help

Question

我在C#中创建了一些自定义PowerShell Cmdlet,并希望提供一些使用get-help cmdlet显示的信息.例如"get-help my-cmdlet".

我创建了一个从PSSnapIn派生的基本snapin,并重写了Description,Name和Vendor属性.我还创建了我的帮助文件"Cmdlets.dll-Help.xml".Cmdlets.dll是此处指示的程序集的正确名称.

我创建了以下脚本来快速测试这个帮助:

$ErrorActionPreference = "Stop"
$scriptFolder = Split-Path $script:MyInvocation.MyCommand.Path

$dll = ($scriptFolder + "\Release\x64\Cmdlets.dll")
Write-Host "Testing Cmdlets in $dll" -fore Green

[System.Reflection.Assembly] $assembly = [System.Reflection.Assembly]::LoadFrom($dll)
Import-Module -assembly $assembly

get-help get-latestfiles

这似乎只是提供了一些关于cmdlet参数的默认帮助,但未能获得我在XML文件中编写的任何示例.有没有人对这是为什么有任何想法？

Answer 1

看来我的帮助有两个问题不起作用。首先，需要将 XML 复制到 Cmdlet DLL 的输出目录才能获取 Powershell。

第二个原因似乎是我的帮助文件中的错误。我不确定这是什么，但 Powershell 似乎只是默默地失败，即使错误操作首选项设置为停止。我最终直接从 C:\Windows\System32\WindowsPowerShell\v1.0\en-US\Microsoft.PowerShell.Commands.Management.dll-Help.xml 中提取 XML 并修改它以满足我的需要。