编写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

但是老实说，这是微软的帮助，这不太有帮助。

Answer 1

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

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

它可以让您更好地了解Microsoft自己如何使用此格式