2014-10-29 45 views
8

自定義PowerShell腳本或函數可以在它的身體開始時的標準註釋進行記錄。但是,我如何在自定義對象中記錄自定義ScriptMethod?以下不起作用:添加文檔,以自定義方法(ScriptMethod)

$myClass | add-member -memType ScriptMethod -Name "Foo" -Value { 
    <# 
     .SYNOPSIS 
     Something - but brief 
     .DESCRIPTION 
     Something 
    #> 
    <# ... #> 
} 

是否有一些標準的方法來記錄您的ScriptMethods?

+0

'$ myClass'是什麼? – Eris 2014-11-07 23:22:25

+0

我遵循定義類的方法,並在http://powertoe.wordpress.com/2014/04/26/you-know-powershell-is-an-object-oriented-language-right/ – Sh4pe 2014-11-08 00:25:44

+0

I很可能只是將其編寫爲C#模塊並使用XML幫助文件。不是一個答案,而是一個可能的選擇。 – Eris 2014-11-10 20:23:06

回答

1

您可以編寫腳本的方法作爲一個單獨的函數首先(像你這樣做wellDocumented),然後通過功能的腳本塊:

$myClass | add-member -memType ScriptMethod -Name "Foo" -Value ${function:wellDocumented} 

你仍然不能叫Get-Help $myClass.Foo,但你可以請致電Get-Help wellDocumented

在我的測試中,我無法獲得有關方法的幫助。

+0

但是,然後我的課程的用戶將不得不查看實施,以發現他/她有'幫助wellDocumented'來尋求幫助 - 這比僅僅查看實現並閱讀那裏的文檔更麻煩。 ..雖然感謝您的答案! – Sh4pe 2014-10-29 15:04:52

相關問題