编写 Powershell 帮助文件

Question

我正在尝试为我用 C# 编写的一堆 PowerShell 模块编写一些帮助文件。我一直在努力寻找任何东西，并尝试使用此帮助编辑器

https://pscmdlethelpeditor.codeplex.com/

但我正在尝试与作者一起解决一些错误。长话短说，它说它使用 powershell 2.0，并且正在尝试使用 3.0。

回到主题，我需要一种可靠的方法来了解如何为我的 c# powershell 模块编写帮助文件。我试过关注 MSDN

http://msdn.microsoft.com/en-us/library/bb525433(v=vs.85).aspx

但老实说，这是 microsoft 的帮助，这没什么帮助。

Answer 1

正如您所发现的，MSDN 上的帮助文档给您留下了很多想象空间。如果您喜欢通过示例学习，可以查看现有 PowerShell 模块的帮助文件：

$fs = Get-ChildItem C:\Windows\System32\WindowsPowerShell\v1.0\Modules -Recurse 
$fs |Where {$_.Name -like "*dll-Help.xml"} |Select FullName

它会让你更好地了解微软自己是如何使用这种格式的