2014-06-06 89 views
2

我正在嘗試爲我用C#編寫的一堆PowerShell模塊編寫一些幫助文件。我一直在努力盡可能這樣發現了什麼,以及使用這種幫助編輯書寫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

,但說實話,這是微軟的幫助,這是不到有用的。

+1

乘坐看看[幫助](https://github.com/nightroman/Helps)。我爲自己創造了它,並在幾個項目中使用了好幾年。這也許很不尋常,但它確實很有用。實際上很簡單。 –

+0

@RomanKuzmin你的評論看起來像是對我的回答... – BartekB

回答

0

正如您發現的那樣,MSDN上的幫助文檔給您留下了很多想象。如果你喜歡以身作則學習,你可以看看幫助文件對現有PowerShell模塊:

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

它會給你如何自我微軟使用這種格式更好的主意