共用方式為

Write-Debug

模組:
Microsoft.PowerShell.Utility Module

將偵錯訊息寫入主控台。

語法

Default (預設值) 

Write-Debug
    [-Message] <String>
    [<CommonParameters>]

Description

Write-Debug Cmdlet 會從腳本或命令將偵錯訊息寫入主機。

根據預設，偵錯訊息不會顯示在控制台中，但您可以使用 Debug 參數或 $DebugPreference 變數來顯示訊息。

範例

範例 1：瞭解$DebugPreference

此範例會寫入偵錯訊息。

Write-Debug "Cannot open file."

$DebugPreference 預設值為 SilentlyContinue。 因此，訊息不會顯示在控制台中。

範例 2：變更 $DebugPreference 的值

此範例顯示變更 $DebugPreference 變數值的效果。 首先，我們會顯示目前 $DebugPreference 值，並嘗試寫入偵錯訊息。 然後，我們將 $DebugPreference 的值變更為 Continue，以允許顯示偵錯訊息。

PS> $DebugPreference
SilentlyContinue
PS> Write-Debug "Cannot open file."
PS>
PS> $DebugPreference = "Continue"
PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.

如需 $DebugPreference的詳細資訊，請參閱 about_Preference_Variables。

範例 3：使用 Debug 參數 覆寫 $DebugPreference

Test-Debug 函式會將 $DebugPreference 變數的值寫入 PowerShell 主機和偵錯數據流。 在此範例中，我們使用 Debug 參數來覆寫 $DebugPreference 值。

function Test-Debug {
    [CmdletBinding()]
    param()
    Write-Debug ('$DebugPreference is ' + $DebugPreference)
    Write-Host ('$DebugPreference is ' + $DebugPreference)
}

PS> Test-Debug
$DebugPreference is SilentlyContinue

PS> Test-Debug -Debug
DEBUG: $DebugPreference is Continue
$DebugPreference is Continue
PS> $DebugPreference
SilentlyContinue

請注意，當您使用 $DebugPreference 參數時， 的值會變更。 這項變更只會影響函式的範圍。 值不會在函式外部受到影響。

如需 偵錯 一般參數的詳細資訊，請參閱 about_CommonParameters。

參數

-Message

指定要傳送至主控台的偵錯訊息。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
別名:味精

參數集

(All)
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

String

您可以將包含偵錯訊息的字串透過管道傳送至此 cmdlet。

輸出

None

此 Cmdlet 不會傳回任何輸出。 它只會寫入偵錯數據流。