Write-Debug

模組:: Microsoft.PowerShell.Utility Module

會寫入除錯訊息給主控台。

語法

Default (預設值)

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

Description

Write-Debug指令長會從腳本或指令向主機寫入除錯訊息。

預設情況下，除錯訊息不會在主控台顯示，但你可以透過除錯參數或變 $DebugPreference 數來顯示。

範例

範例一：理解$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

注意當你使用 Debug 參數時，的$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。